jtag.hpp

#pragma once
 
#include <cstdint>
 
#include "libxr_def.hpp"
 
namespace LibXR::Debug
{
enum class TapState : uint8_t
{
  TEST_LOGIC_RESET = 0,
  RUN_TEST_IDLE,
  SELECT_DR_SCAN,
  CAPTURE_DR,
  SHIFT_DR,
  EXIT1_DR,
  PAUSE_DR,
  EXIT2_DR,
  UPDATE_DR,
  SELECT_IR_SCAN,
  CAPTURE_IR,
  SHIFT_IR,
  EXIT1_IR,
  PAUSE_IR,
  EXIT2_IR,
  UPDATE_IR,
};
 
class Jtag
{
 public:
  virtual ~Jtag() = default;
 
  Jtag(const Jtag&) = delete;
  Jtag& operator=(const Jtag&) = delete;
 
  virtual ErrorCode SetClockHz(uint32_t hz) = 0;
 
  virtual void Close() = 0;
 
  virtual ErrorCode ResetTap() = 0;
 
  virtual ErrorCode GotoState(TapState target) = 0;
 
  virtual ErrorCode ShiftIR(uint32_t bits, const uint8_t* in_lsb_first,
                            uint8_t* out_lsb_first) = 0;
 
  virtual ErrorCode ShiftDR(uint32_t bits, const uint8_t* in_lsb_first,
                            uint8_t* out_lsb_first) = 0;
 
  virtual ErrorCode Sequence(uint32_t cycles, bool tms, const uint8_t* tdi_lsb_first,
                             uint8_t* tdo_lsb_first) = 0;
 
  virtual void IdleClocks(uint32_t cycles) = 0;
 
 protected:
  Jtag() = default;
};
 
}  // namespace LibXR::Debug