swd_protocol.hpp

// swd_protocol.hpp
#pragma once
 
#include <cstdint>
 
namespace LibXR::Debug::SwdProtocol
{
enum class Port : uint8_t
{
  DP = 0,  
  AP = 1,  
};
 
enum class Pin : uint8_t
{
  SWCLK = 0,  
  SWDIO = 1,  
};
 
enum class Ack : uint8_t
{
  NO_ACK = 0x0,    
  OK = 0x1,        
  WAIT = 0x2,      
  FAULT = 0x4,     
  PROTOCOL = 0x7,  
};
 
struct Request
{
  Port port = Port::DP;  
  bool rnw =
      true;  
  uint8_t addr2b = 0;  
  uint32_t wdata = 0;  
};
 
struct Response
{
  Ack ack = Ack::PROTOCOL;  
  uint32_t rdata = 0;  
  bool parity_ok = true;  
};
 
enum class DpReadReg : uint8_t
{
  IDCODE = 0,     
  CTRL_STAT = 1,  
  SELECT = 2,     
  RDBUFF = 3,     
};
 
enum class DpWriteReg : uint8_t
{
  ABORT = 0,      
  CTRL_STAT = 1,  
  SELECT = 2,     
};
 
inline constexpr uint32_t DP_ABORT_DAPABORT = (1u << 0);    
inline constexpr uint32_t DP_ABORT_STKCMPCLR = (1u << 1);   
inline constexpr uint32_t DP_ABORT_STKERRCLR = (1u << 2);   
inline constexpr uint32_t DP_ABORT_WDERRCLR = (1u << 3);    
inline constexpr uint32_t DP_ABORT_ORUNERRCLR = (1u << 4);  
 
inline constexpr uint32_t DP_CTRLSTAT_CDBGPWRUPREQ =
    (1u << 28);  
inline constexpr uint32_t DP_CTRLSTAT_CDBGPWRUPACK =
    (1u << 29);  
inline constexpr uint32_t DP_CTRLSTAT_CSYSPWRUPREQ =
    (1u << 30);  
inline constexpr uint32_t DP_CTRLSTAT_CSYSPWRUPACK =
    (1u << 31);  
 
constexpr uint32_t make_select(uint8_t apsel, uint8_t apbanksel, uint8_t dpbanksel = 0)
{
  return (static_cast<uint32_t>(apsel) << 24) |
         ((static_cast<uint32_t>(apbanksel) & 0x0Fu) << 4) |
         (static_cast<uint32_t>(dpbanksel) & 0x0Fu);
}
 
constexpr Request make_dp_read_req(DpReadReg reg)
{
  return Request{Port::DP, true, static_cast<uint8_t>(reg), 0u};
}
 
constexpr Request make_dp_write_req(DpWriteReg reg, uint32_t wdata)
{
  return Request{Port::DP, false, static_cast<uint8_t>(reg), wdata};
}
 
constexpr Request make_ap_read_req(uint8_t addr2b)
{
  return Request{Port::AP, true, static_cast<uint8_t>(addr2b & 0x03u), 0u};
}
 
constexpr Request make_ap_write_req(uint8_t addr2b, uint32_t wdata)
{
  return Request{Port::AP, false, static_cast<uint8_t>(addr2b & 0x03u), wdata};
}
 
}  // namespace LibXR::Debug::SwdProtocol