daplink_v2_def.hpp

#pragma once
 
#include <cstdint>
 
#include "libxr_def.hpp"
#include "timebase.hpp"
 
namespace LibXR::USB
{
 
namespace DapLinkV2Def
{
 
// ==============================
// Limits / 限制
// ==============================
 
static constexpr std::uint16_t MAX_REQUEST_SIZE =
    512u;  
static constexpr std::uint16_t MAX_RESPONSE_SIZE =
    512u;  
 
// ==============================
// CMSIS-DAP v2 Command IDs / 命令号
// 注意：按规范值定义（SWO_Data=0x1C, SWD_Sequence=0x1D）
// Note: Values follow the CMSIS-DAP specification (SWO_Data=0x1C, SWD_Sequence=0x1D).
// ==============================
 
enum class CommandId : std::uint8_t
{
  // Core (0x00-0x0F)
  INFO = 0x00,
  HOST_STATUS = 0x01,
  CONNECT = 0x02,
  DISCONNECT = 0x03,
  TRANSFER_CONFIGURE = 0x04,
  TRANSFER = 0x05,
  TRANSFER_BLOCK = 0x06,
  TRANSFER_ABORT = 0x07,
  WRITE_ABORT = 0x08,
  DELAY = 0x09,
  RESET_TARGET = 0x0A,
 
  // SWJ (0x10-0x1F)
  SWJ_PINS = 0x10,
  SWJ_CLOCK = 0x11,
  SWJ_SEQUENCE = 0x12,
  SWD_CONFIGURE = 0x13,
  JTAG_SEQUENCE = 0x14,
  JTAG_CONFIGURE = 0x15,
  JTAG_IDCODE = 0x16,
 
  // SWO (v2)
  SWO_TRANSPORT = 0x17,
  SWO_MODE = 0x18,
  SWO_BAUDRATE = 0x19,
  SWO_CONTROL = 0x1A,
  SWO_STATUS = 0x1B,
  SWO_DATA = 0x1C,
 
  // SWD sequence (v2)
  SWD_SEQUENCE = 0x1D,
 
  // Queue (0x7E-0x7F)
  QUEUE_COMMANDS = 0x7E,
  EXECUTE_COMMANDS = 0x7F,
 
  INVALID = 0xFF
};
 
// ==============================
// DAP_Info IDs / 信息 ID
// ==============================
 
enum class InfoId : std::uint8_t
{
  VENDOR = 0x01,
  PRODUCT = 0x02,
  SERIAL_NUMBER = 0x03,
  FIRMWARE_VERSION = 0x04,
 
  DEVICE_VENDOR = 0x05,
  DEVICE_NAME = 0x06,
  BOARD_VENDOR = 0x07,
  BOARD_NAME = 0x08,
  PRODUCT_FIRMWARE_VERSION = 0x09,
 
  CAPABILITIES = 0xF0,
  TIMESTAMP_CLOCK = 0xF1,
  SWO_BUFFER_SIZE = 0xFD,
  PACKET_COUNT = 0xFE,
  PACKET_SIZE = 0xFF
};
 
// ==============================
// Capabilities bits / 能力位（DAP_Info: Capabilities）
// ==============================
 
static constexpr std::uint8_t DAP_CAP_SWD = 0x01u;   
static constexpr std::uint8_t DAP_CAP_JTAG = 0x02u;  
static constexpr std::uint8_t DAP_CAP_SWO = 0x04u;   
 
// ==============================
// Status / Port / 状态与端口
// ==============================
 
enum class Status : std::uint8_t
{
  OK = 0x00,
  ERROR = 0xFF
};
 
enum class Port : std::uint8_t
{
  DISABLED = 0x00,
  SWD = 0x01,
  JTAG = 0x02
};
 
enum class DebugPort : std::uint8_t
{
  DISABLED = 0,
  SWD = 1,
  JTAG = 2
};
 
// ==============================
// Transfer Request bits / 传输请求位
// ==============================
 
static constexpr std::uint8_t DAP_TRANSFER_APNDP = (1u << 0);
static constexpr std::uint8_t DAP_TRANSFER_RNW = (1u << 1);
static constexpr std::uint8_t DAP_TRANSFER_A2 = (1u << 2);
static constexpr std::uint8_t DAP_TRANSFER_A3 = (1u << 3);
static constexpr std::uint8_t DAP_TRANSFER_MATCH_VALUE = (1u << 4);
static constexpr std::uint8_t DAP_TRANSFER_MATCH_MASK = (1u << 5);
static constexpr std::uint8_t DAP_TRANSFER_TIMESTAMP = (1u << 7);  
 
// Transfer Response bits / 传输响应位
static constexpr std::uint8_t DAP_TRANSFER_OK = (1u << 0);
static constexpr std::uint8_t DAP_TRANSFER_WAIT = (1u << 1);
static constexpr std::uint8_t DAP_TRANSFER_FAULT = (1u << 2);
static constexpr std::uint8_t DAP_TRANSFER_ERROR = (1u << 3);
static constexpr std::uint8_t DAP_TRANSFER_MISMATCH = (1u << 4);
static constexpr std::uint8_t DAP_TRANSFER_NO_TARGET = (1u << 7);  
 
// ==============================
// SWJ Pins bits / SWJ 引脚位
// ==============================
 
static constexpr std::uint8_t DAP_SWJ_SWCLK_TCK = (1u << 0);
static constexpr std::uint8_t DAP_SWJ_SWDIO_TMS = (1u << 1);
static constexpr std::uint8_t DAP_SWJ_TDI = (1u << 2);
static constexpr std::uint8_t DAP_SWJ_TDO = (1u << 3);
static constexpr std::uint8_t DAP_SWJ_NTRST = (1u << 5);
static constexpr std::uint8_t DAP_SWJ_NRESET = (1u << 7);
 
// ==============================
// SWD / JTAG Sequence fields / 序列字段
// ==============================
 
static constexpr std::uint8_t SWD_SEQUENCE_CLK = 0x3Fu;
static constexpr std::uint8_t SWD_SEQUENCE_DIN = (1u << 7);
 
static constexpr std::uint8_t JTAG_SEQUENCE_TCK = 0x3Fu;
static constexpr std::uint8_t JTAG_SEQUENCE_TMS = (1u << 6);
static constexpr std::uint8_t JTAG_SEQUENCE_TDO = (1u << 7);
 
// ==============================
// Helpers / 工具函数
// ==============================
 
static inline constexpr std::uint8_t req_addr2b(std::uint8_t req)
{
  return static_cast<std::uint8_t>(((req & DAP_TRANSFER_A2) ? 1u : 0u) |
                                   ((req & DAP_TRANSFER_A3) ? 2u : 0u));
}
 
static inline constexpr bool req_is_ap(std::uint8_t req)
{
  return (req & DAP_TRANSFER_APNDP) != 0u;
}
 
static inline constexpr bool req_is_read(std::uint8_t req)
{
  return (req & DAP_TRANSFER_RNW) != 0u;
}
 
static inline constexpr bool req_need_timestamp(std::uint8_t req)
{
  return (req & DAP_TRANSFER_TIMESTAMP) != 0u;
}
 
// ==============================
// State structs / 运行态结构体
// ==============================
 
struct TransferConfig
{
  std::uint8_t idle_cycles = 0u;     
  std::uint16_t retry_count = 100u;  
  std::uint16_t match_retry = 0u;    
  std::uint32_t match_mask = 0u;     
};
 
struct SwdConfig
{
  std::uint8_t turnaround = 1u;  
  bool data_phase = false;       
};
 
struct State
{
  DebugPort debug_port = DebugPort::DISABLED;  
  volatile bool transfer_abort = false;        
 
  TransferConfig transfer_cfg;  
  SwdConfig swd_cfg;            
};
 
struct CommandResult
{
  std::uint16_t request_consumed = 0u;    
  std::uint16_t response_generated = 0u;  
};
 
}  // namespace DapLinkV2Def
 
}  // namespace LibXR::USB