RlinkCommand.ipp

Go to the documentation of this file.

// $Id: RlinkCommand.ipp 1185 2019-07-12 17:29:12Z mueller $
// SPDX-License-Identifier: GPL-3.0-or-later
// Copyright 2011-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
// 
// Revision History: 
// Date         Rev Version  Comment
// 2019-03-10  1121   1.4.2  add BlockDoneAll()
// 2018-12-24  1092   1.4.1  rename IsBlockExt -> HasBlockExt
// 2018-12-01  1076   1.4    use unique_ptr
// 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
// ---------------------------------------------------------------------------
 
// all method definitions in namespace Retro
namespace Retro {
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::CmdRreg(uint16_t addr)
{
  SetCommand(kCmdRreg, addr);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::CmdWreg(uint16_t addr, uint16_t data)
{
  SetCommand(kCmdWreg, addr, data);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::CmdLabo()
{
  SetCommand(kCmdLabo);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::CmdAttn()
{
  SetCommand(kCmdAttn);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::CmdInit(uint16_t addr, uint16_t data)
{
  SetCommand(kCmdInit, addr, data);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetSeqNumber(uint8_t snum)
{
  fRequest = (snum<<3) | (fRequest&0x07);
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetData(uint16_t data)
{
  fData = data;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetBlockDone(uint16_t dcnt)
{
  fBlockDone = dcnt;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetStatus(uint8_t stat)
{
  fStatus = stat;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetFlagBit(uint32_t mask)
{
  fFlags |= mask;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::ClearFlagBit(uint32_t mask)
{
  fFlags &= ~mask;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetRcvSize(size_t rsize)
{
  fRcvSize = rsize;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline RlinkCommandExpect& RlinkCommand::EnsureExpect()
{
  if (!fupExpect) fupExpect.reset(new RlinkCommandExpect());
  return *fupExpect;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetExpectStatus(uint8_t stat, uint8_t statmsk)
{
  fExpectStatusSet = true;
  fExpectStatusVal = stat;
  fExpectStatusMsk = statmsk;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline void RlinkCommand::SetExpectStatusDefault(uint8_t stat, uint8_t statmsk)
{
  fExpectStatusSet = false;
  fExpectStatusVal = stat;
  fExpectStatusMsk = statmsk;
  return;
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::Request() const
{
  return fRequest;
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::Command() const
{
  return fRequest & 0x07;
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::SeqNumber() const
{
  return fRequest>>3;
}
 
//------------------------------------------+-----------------------------------
 
inline uint16_t RlinkCommand::Address() const
{
  return fAddress;
}
 
//------------------------------------------+-----------------------------------
 
inline uint16_t RlinkCommand::Data() const
{
  return fData;
}
 
//------------------------------------------+-----------------------------------
 
inline const std::vector<uint16_t>&  RlinkCommand::Block() const
{
  return fBlock;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::HasBlockExt() const
{
  return bool(fpBlockExt);
}
 
//------------------------------------------+-----------------------------------
 
inline uint16_t* RlinkCommand::BlockPointer()
{
  return HasBlockExt() ? fpBlockExt : (fBlock.size() ? &fBlock[0] : nullptr);
}
 
//------------------------------------------+-----------------------------------
 
inline const uint16_t* RlinkCommand::BlockPointer() const
{
  return HasBlockExt() ? fpBlockExt : (fBlock.size() ? &fBlock[0] : nullptr);
}
 
//------------------------------------------+-----------------------------------
 
inline size_t RlinkCommand::BlockSize() const
{
  return HasBlockExt() ? fBlockExtSize : fBlock.size();
}
 
//------------------------------------------+-----------------------------------
 
inline size_t RlinkCommand::BlockDone() const
{
  return fBlockDone;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::BlockDoneAll() const
{
  return BlockDone() == BlockSize();
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::Status() const
{
  return fStatus;
}
 
//------------------------------------------+-----------------------------------
 
inline uint32_t RlinkCommand::Flags() const
{
  return fFlags;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::TestFlagAny(uint32_t mask) const
{
  return (fFlags & mask) != 0;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::TestFlagAll(uint32_t mask) const
{
  return (fFlags & mask) == fFlags;
}
 
//------------------------------------------+-----------------------------------
 
inline size_t RlinkCommand::RcvSize() const
{
  return fRcvSize;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::HasExpect() const
{
  return bool(fupExpect);
}
 
//------------------------------------------+-----------------------------------
 
inline const RlinkCommandExpect& RlinkCommand::Expect() const
{
  return *fupExpect;
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::ExpectStatusValue() const
{
  return fExpectStatusVal;
}
 
//------------------------------------------+-----------------------------------
 
inline uint8_t RlinkCommand::ExpectStatusMask() const
{
  return fExpectStatusMsk;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::ExpectStatusSet() const
{
  return fExpectStatusSet;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::StatusCheck() const
{
  return (fStatus & fExpectStatusMsk) == fExpectStatusVal;
}
 
//------------------------------------------+-----------------------------------
 
inline bool RlinkCommand::StatusIsChecked() const
{
  return fExpectStatusMsk != 0x0;
}
 
} // end namespace Retro