dfu_bootloader.hpp

#pragma once
 
#include <cstring>
 
#include "dfu/dfu_def.hpp"
 
namespace LibXR::USB
{
class DfuBootloaderBackend
{
 public:
  using JumpCallback = void (*)(void*);
  static constexpr uint32_t SEAL_MAGIC = 0x4C414553u;  // "SEAL"
 
  LIBXR_PACKED_BEGIN
  struct SealRecord
  {
    uint32_t magic = SEAL_MAGIC;
    uint32_t image_size = 0u;
    uint32_t crc32 = 0u;
    uint32_t crc32_inv = 0u;
  };
  LIBXR_PACKED_END
 
  // Backend 负责：
  // - 管理 download/upload/manifest 状态
  // - 通过 Flash 基类接口驱动擦写读
  // - 维护镜像有效性与 seal 元数据
  // Backend responsibilities:
  // - own download/upload/manifest bookkeeping
  // - drive flash erase/write/read through the Flash base interface
  // - maintain image validity and seal metadata
  DfuBootloaderBackend(Flash& flash, size_t image_offset, size_t image_size_limit,
                       size_t seal_offset, JumpCallback jump_to_app,
                       void* jump_app_ctx = nullptr, bool autorun = true)
      : flash_(flash),
        image_offset_(image_offset),
        image_size_limit_(image_size_limit),
        seal_offset_(seal_offset),
        jump_to_app_(jump_to_app),
        jump_app_ctx_(jump_app_ctx),
        autorun_(autorun)
  {
    erase_block_size_ = flash_.MinEraseSize();
    if (erase_block_size_ == 0u)
    {
      erase_block_size_ = 1u;
    }
    erase_block_count_ = (image_size_limit_ + erase_block_size_ - 1u) / erase_block_size_;
    if (erase_block_count_ > 0u)
    {
      erased_blocks_ = new uint8_t[erase_block_count_];
      std::memset(erased_blocks_, 0, erase_block_count_);
    }
    seal_storage_size_ =
        AlignUp(sizeof(SealRecord), NonZeroWriteSize(flash_.MinWriteSize()));
    seal_storage_ = new uint8_t[seal_storage_size_];
    transfer_size_ = PayloadLimit();
    if (transfer_size_ == 0u)
    {
      transfer_size_ = 1024u;
    }
    if (transfer_size_ > 4096u)
    {
      transfer_size_ = 4096u;
    }
    write_buffer_ = new uint8_t[transfer_size_];
    ResetTransferState();
    image_.launch_requested = false;
    image_.ready = false;
    image_.stored_size = 0u;
  }
 
  DfuBootloaderBackend(const DfuBootloaderBackend&) = delete;
  DfuBootloaderBackend& operator=(const DfuBootloaderBackend&) = delete;
 
  DFUCapabilities GetDfuCapabilities() const
  {
    DFUCapabilities caps = {};
    caps.can_download = true;
    caps.can_upload = true;
    caps.manifestation_tolerant = false;
    caps.will_detach = false;
    caps.detach_timeout_ms = 0u;
 
    if (transfer_size_ > 0xFFFFu)
    {
      caps.transfer_size = 0xFFFFu;
    }
    else
    {
      caps.transfer_size = static_cast<uint16_t>(transfer_size_);
    }
    return caps;
  }
 
  ErrorCode DfuSetAlternate(uint8_t alt)
  {
    return (alt == 0u) ? ErrorCode::OK : ErrorCode::NOT_SUPPORT;
  }
 
  void DfuAbort(uint8_t)
  {
    ResetTransferState();
    image_.launch_requested = false;
    image_.ready = false;
    image_.stored_size = 0u;
  }
 
  void DfuClearStatus(uint8_t)
  {
    ResetTransferState();
    image_.launch_requested = false;
  }
 
  DFUStatusCode DfuDownload(uint8_t alt, uint16_t block_num, ConstRawData data,
                            uint32_t& poll_timeout_ms)
  {
    poll_timeout_ms = 0u;
 
    if (alt != 0u)
    {
      return DFUStatusCode::ERR_TARGET;
    }
    if (data.addr_ == nullptr || data.size_ == 0u || data.size_ > transfer_size_)
    {
      return DFUStatusCode::ERR_USBR;
    }
    if (HasPendingWrite() || HasPendingManifest())
    {
      return DFUStatusCode::ERR_NOTDONE;
    }
 
    if ((block_num == 0u) &&
        (download_.session_started &&
         (download_.received_bytes != 0u || download_.expected_block_num != 0u)))
    {
      // 主机没有先发 ABORT/CLRSTATUS，就直接从 block 0 重启 DNLOAD；
      // 这里把它视为新会话，并丢弃旧的部分传输状态。
      // The host restarted DNLOAD from block 0 without an explicit
      // ABORT/CLRSTATUS first; treat that as a fresh session and discard the
      // old partial transfer state.
      ResetTransferState();
    }
 
    if (!download_.session_started)
    {
      if (block_num != 0u)
      {
        return DFUStatusCode::ERR_ADDRESS;
      }
      StartDownloadSession();
    }
    else if (block_num != download_.expected_block_num)
    {
      return DFUStatusCode::ERR_ADDRESS;
    }
 
    const size_t offset = download_.received_bytes;
    const size_t payload_limit = PayloadLimit();
    if (offset + data.size_ < offset || (offset + data.size_) > payload_limit)
    {
      return DFUStatusCode::ERR_ADDRESS;
    }
 
    std::memcpy(write_buffer_, data.addr_, data.size_);
    write_.offset = offset;
    write_.len = data.size_;
    write_.block_num = block_num;
    write_.pending = true;
    download_.last_status = DFUStatusCode::OK;
    download_.next_poll_timeout_ms = ComputeWritePollTimeout(offset, data.size_);
    poll_timeout_ms = download_.next_poll_timeout_ms;
    return DFUStatusCode::OK;
  }
 
  DFUStatusCode DfuGetDownloadStatus(uint8_t alt, bool& busy, uint32_t& poll_timeout_ms)
  {
    if (alt != 0u)
    {
      busy = false;
      poll_timeout_ms = 0u;
      return DFUStatusCode::ERR_TARGET;
    }
    busy = HasPendingWrite();
    poll_timeout_ms = busy ? download_.next_poll_timeout_ms : 0u;
    return download_.last_status;
  }
 
  size_t DfuUpload(uint8_t alt, uint16_t block_num, RawData data, DFUStatusCode& status,
                   uint32_t& poll_timeout_ms)
  {
    poll_timeout_ms = 0u;
    status = DFUStatusCode::OK;
 
    if (alt != 0u)
    {
      status = DFUStatusCode::ERR_TARGET;
      return 0u;
    }
    if (data.addr_ == nullptr || data.size_ == 0u)
    {
      status = DFUStatusCode::ERR_USBR;
      return 0u;
    }
 
    if (block_num == 0u)
    {
      upload_.session_started = true;
      upload_.offset = 0u;
      upload_.expected_block_num = 1u;
      size_t image_size = 0u;
      if (image_.ready)
      {
        image_size = image_.stored_size;
      }
      else if (!ProbeStoredImage(&image_size))
      {
        image_size = 0u;
      }
      upload_.image_size = image_size;
      if (upload_.image_size == 0u)
      {
        status = DFUStatusCode::ERR_FIRMWARE;
        return 0u;
      }
    }
    else if (!upload_.session_started || block_num != upload_.expected_block_num)
    {
      status = DFUStatusCode::ERR_ADDRESS;
      return 0u;
    }
 
    if (upload_.offset >= upload_.image_size)
    {
      return 0u;
    }
 
    size_t read_size = upload_.image_size - upload_.offset;
    if (read_size > data.size_)
    {
      read_size = data.size_;
    }
    if (flash_.Read(image_offset_ + upload_.offset,
                    {reinterpret_cast<uint8_t*>(data.addr_), read_size}) != ErrorCode::OK)
    {
      status = DFUStatusCode::ERR_FIRMWARE;
      return 0u;
    }
 
    upload_.offset += read_size;
    upload_.expected_block_num = static_cast<uint16_t>(block_num + 1u);
    return read_size;
  }
 
  DFUStatusCode DfuManifest(uint8_t alt, uint32_t& poll_timeout_ms)
  {
    poll_timeout_ms = 0u;
 
    if (alt != 0u)
    {
      return DFUStatusCode::ERR_TARGET;
    }
    if (!download_.session_started || download_.received_bytes == 0u || HasPendingWrite())
    {
      return DFUStatusCode::ERR_NOTDONE;
    }
    manifest_.pending = true;
    manifest_.last_status = DFUStatusCode::OK;
    poll_timeout_ms = manifest_.poll_timeout_ms;
    return DFUStatusCode::OK;
  }
 
  DFUStatusCode DfuGetManifestStatus(uint8_t alt, bool& busy, uint32_t& poll_timeout_ms)
  {
    if (alt != 0u)
    {
      busy = false;
      poll_timeout_ms = 0u;
      return DFUStatusCode::ERR_TARGET;
    }
    busy = HasPendingManifest();
    poll_timeout_ms = busy ? manifest_.poll_timeout_ms : 0u;
    return manifest_.last_status;
  }
 
  void Process()
  {
    // 这里仅推进协议自身拥有的异步工作；
    // app launch 仍然保持为显式的板级/应用层策略决策。
    // Only protocol-owned asynchronous work advances here;
    // app launch remains an explicit board/application policy decision.
    if (write_.pending)
    {
      ProcessPendingWrite();
      return;
    }
    if (manifest_.pending)
    {
      ProcessPendingManifest();
    }
  }
 
  bool TryRequestRunApp()
  {
    // Run-app 请求不修改 DFU 传输状态；它只记录一个待消费的镜像启动请求，
    // 由外层 boot/application 循环决定何时真正跳转。
    // The run-app request does not mutate DFU transfer state; it only records
    // an image-backed launch request for the outer boot/application loop.
    if (!image_.ready)
    {
      size_t image_size = 0u;
      image_.ready = ProbeStoredImage(&image_size);
      image_.stored_size = image_.ready ? image_size : 0u;
    }
    if (image_.ready)
    {
      image_.launch_requested = true;
      return true;
    }
    return false;
  }
 
  void DfuCommitManifestWaitReset(uint8_t alt)
  {
    if (alt != 0u)
    {
      return;
    }
    if (autorun_ && image_.ready)
    {
      image_.launch_requested = true;
    }
  }
 
  bool TryConsumeAppLaunch(uint32_t)
  {
    if (!image_.launch_requested || !image_.ready)
    {
      return false;
    }
    image_.launch_requested = false;
    if (jump_to_app_ != nullptr)
    {
      jump_to_app_(jump_app_ctx_);
    }
    return true;
  }
 
  bool HasPendingWork() const { return HasPendingWrite() || HasPendingManifest(); }
 
  bool HasValidImage() const { return image_.ready; }
  size_t ImageSize() const { return image_.stored_size; }
 
 private:
  // download/upload 只允许访问 seal 记录之前的 payload 区域。
  // Download/upload only operate on the payload area before the seal record.
  size_t PayloadLimit() const
  {
    if (seal_offset_ > image_size_limit_)
    {
      return 0u;
    }
    return seal_offset_;
  }
 
  static size_t NonZeroWriteSize(size_t write_size)
  {
    return (write_size == 0u) ? 1u : write_size;
  }
 
  static size_t AlignUp(size_t value, size_t align)
  {
    if (align <= 1u)
    {
      return value;
    }
    const size_t rem = value % align;
    return (rem == 0u) ? value : (value + align - rem);
  }
 
  // 开启新的下载会话，并使之前缓存的镜像有效性视图失效。
  // Start a fresh download session and invalidate any previously cached image view.
  void StartDownloadSession()
  {
    ResetTransferState();
    if (erase_block_count_ > 0u)
    {
      std::memset(erased_blocks_, 0, erase_block_count_);
    }
    download_.session_started = true;
    image_.ready = false;
    image_.stored_size = 0u;
    image_.launch_requested = false;
  }
 
  void ResetTransferState()
  {
    // 这里只重置协议拥有的传输会话状态；
    // 镜像有效性和启动策略单独放在 ImageState 里。
    // Reset only protocol-owned transfer session state;
    // image validity and launch policy are tracked separately in ImageState.
    download_ = {};
    write_ = {};
    manifest_ = {};
    upload_ = {};
  }
 
  bool HasPendingWrite() const { return write_.pending; }
 
  bool HasPendingManifest() const { return manifest_.pending; }
 
  // 为下一次 GETSTATUS 返回一个粗粒度的 host-visible poll timeout；
  // 仍需擦除的块会比纯写入步骤报告更长的等待时间。
  // Return a coarse host-visible poll timeout for the next GETSTATUS;
  // blocks that still need erase are reported slower than pure program-only writes.
  uint32_t ComputeWritePollTimeout(size_t offset, size_t len) const
  {
    const size_t first_block = offset / erase_block_size_;
    const size_t last_block = (offset + len - 1u) / erase_block_size_;
    for (size_t block = first_block; block <= last_block && block < erase_block_count_;
         ++block)
    {
      if (erased_blocks_[block] == 0u)
      {
        return 25u;
      }
    }
    return 10u;
  }
 
  // 执行一次延迟写入步骤：
  // 1) 对新覆盖到的擦除块各擦一次
  // 2) 再把刚收到的 payload 分片编程进去
  // Execute one deferred write step:
  // 1) erase each newly touched erase block once
  // 2) program the just-received payload chunk
  void ProcessPendingWrite()
  {
    if (!EnsureBlocksErased(write_.offset, write_.len))
    {
      download_.last_status = DFUStatusCode::ERR_ERASE;
      write_.pending = false;
      return;
    }
    if (flash_.Write(image_offset_ + write_.offset, {write_buffer_, write_.len}) !=
        ErrorCode::OK)
    {
      download_.last_status = DFUStatusCode::ERR_PROG;
      write_.pending = false;
      return;
    }
 
    download_.received_bytes = write_.offset + write_.len;
    download_.expected_block_num = static_cast<uint16_t>(write_.block_num + 1u);
    download_.last_status = DFUStatusCode::OK;
    write_.pending = false;
  }
 
  // 通过计算固定 CRC32 并写入 seal 记录来完成镜像定稿。
  // Finalize the image by computing the fixed CRC32 and writing the seal record.
  void ProcessPendingManifest()
  {
    const size_t payload_limit = PayloadLimit();
    if (download_.received_bytes == 0u || download_.received_bytes > payload_limit)
    {
      manifest_.last_status = DFUStatusCode::ERR_ADDRESS;
      manifest_.pending = false;
      return;
    }
 
    uint32_t crc32 = 0u;
    if (!ComputeImageCrc32(download_.received_bytes, crc32))
    {
      manifest_.last_status = DFUStatusCode::ERR_VERIFY;
      manifest_.pending = false;
      return;
    }
    if (!WriteSeal(download_.received_bytes, crc32))
    {
      manifest_.last_status = DFUStatusCode::ERR_VERIFY;
      manifest_.pending = false;
      return;
    }
 
    image_.stored_size = download_.received_bytes;
    image_.ready = true;
    image_.launch_requested = false;
    manifest_.last_status = DFUStatusCode::OK;
    download_.session_started = false;
    download_.received_bytes = 0u;
    download_.expected_block_num = 0u;
    upload_.session_started = false;
    upload_.offset = 0u;
    upload_.expected_block_num = 0u;
    upload_.image_size = 0u;
    manifest_.pending = false;
  }
 
  // 计算 seal 记录使用的固定 CRC32，只覆盖 payload 区域。
  // Compute the fixed CRC32 used by the seal record over the payload area only.
  bool ComputeImageCrc32(size_t image_size, uint32_t& crc32_out)
  {
    if (!LibXR::CRC32::inited_)
    {
      LibXR::CRC32::GenerateTable();
    }
    uint32_t crc = 0xFFFFFFFFu;
    size_t offset = 0u;
    while (offset < image_size)
    {
      size_t chunk = image_size - offset;
      if (chunk > sizeof(crc_buffer_))
      {
        chunk = sizeof(crc_buffer_);
      }
      if (flash_.Read(image_offset_ + offset, {crc_buffer_, chunk}) != ErrorCode::OK)
      {
        return false;
      }
      const uint8_t* buf = crc_buffer_;
      size_t remain = chunk;
      while (remain-- > 0u)
      {
        crc = LibXR::CRC32::tab_[(crc ^ *buf++) & 0xFFu] ^ (crc >> 8);
      }
      offset += chunk;
    }
    crc32_out = crc;
    return true;
  }
 
  // 从 flash 中读取当前 seal 记录。
  // Read the current seal record from flash.
  bool ReadSeal(SealRecord& seal)
  {
    return flash_.Read(image_offset_ + seal_offset_, {reinterpret_cast<uint8_t*>(&seal),
                                                      sizeof(seal)}) == ErrorCode::OK;
  }
 
  // Seal may share the last erase block with payload. Reuse the per-session
  // erase map so manifest does not wipe a block that was already erased and
  // partially programmed by DNLOAD payload chunks.
  bool WriteSeal(size_t image_size, uint32_t crc32)
  {
    std::memset(seal_storage_, 0xFF, seal_storage_size_);
    auto* seal = reinterpret_cast<SealRecord*>(seal_storage_);
    seal->magic = SEAL_MAGIC;
    seal->image_size = static_cast<uint32_t>(image_size);
    seal->crc32 = crc32;
    seal->crc32_inv = ~crc32;
 
    if (!EnsureBlocksErased(seal_offset_, seal_storage_size_))
    {
      return false;
    }
    return flash_.Write(image_offset_ + seal_offset_,
                        {seal_storage_, seal_storage_size_}) == ErrorCode::OK;
  }
 
  // 探测 flash 当前是否已有有效的已封印镜像，
  // 并可选返回它记录的 payload 大小。
  // Probe whether flash already contains a valid sealed image, and optionally
  // return its stored payload size.
  bool ProbeStoredImage(size_t* out_image_size)
  {
    SealRecord seal = {};
    if (!ReadSeal(seal))
    {
      return false;
    }
    if (seal.magic != SEAL_MAGIC)
    {
      return false;
    }
    if ((seal.crc32 ^ seal.crc32_inv) != 0xFFFFFFFFu)
    {
      return false;
    }
    const size_t image_size = static_cast<size_t>(seal.image_size);
    if (image_size == 0u || image_size > PayloadLimit())
    {
      return false;
    }
    uint32_t actual_crc = 0u;
    if (!ComputeImageCrc32(image_size, actual_crc))
    {
      return false;
    }
    if (actual_crc != seal.crc32)
    {
      return false;
    }
    if (out_image_size != nullptr)
    {
      *out_image_size = image_size;
    }
    return true;
  }
 
  // 对 [offset, offset+len) 覆盖到的每个块，
  // 在一次下载会话里最多只擦除一次。
  // Erase every block touched by [offset, offset+len) at most once per
  // download session.
  bool EnsureBlocksErased(size_t offset, size_t len)
  {
    if (len == 0u)
    {
      return true;
    }
 
    const size_t first_block = offset / erase_block_size_;
    const size_t last_block = (offset + len - 1u) / erase_block_size_;
    if (last_block >= erase_block_count_)
    {
      return false;
    }
 
    for (size_t block = first_block; block <= last_block; ++block)
    {
      if (erased_blocks_[block] != 0u)
      {
        continue;
      }
      const size_t block_offset = block * erase_block_size_;
      if (flash_.Erase(image_offset_ + block_offset, erase_block_size_) != ErrorCode::OK)
      {
        return false;
      }
      erased_blocks_[block] = 1u;
    }
    return true;
  }
 
  struct ImageState
  {
    bool launch_requested = false;
    bool ready = false;
    size_t stored_size = 0u;
  };
 
  struct DownloadState
  {
    bool session_started = false;
    size_t received_bytes = 0u;
    uint16_t expected_block_num = 0u;
    uint32_t next_poll_timeout_ms = 0u;
    DFUStatusCode last_status = DFUStatusCode::OK;
  };
 
  struct WriteState
  {
    size_t offset = 0u;
    size_t len = 0u;
    uint16_t block_num = 0u;
    bool pending = false;
  };
 
  struct ManifestState
  {
    bool pending = false;
    uint32_t poll_timeout_ms = 50u;
    DFUStatusCode last_status = DFUStatusCode::OK;
  };
 
  struct UploadState
  {
    bool session_started = false;
    size_t offset = 0u;
    uint16_t expected_block_num = 0u;
    size_t image_size = 0u;
  };
 
  Flash& flash_;                  
  size_t image_offset_ = 0u;      
  size_t image_size_limit_ = 0u;  
  size_t seal_offset_ = 0u;  
  JumpCallback jump_to_app_ = nullptr;  
  void* jump_app_ctx_ = nullptr;        
  bool autorun_ = true;    
  ImageState image_ = {};  
  size_t erase_block_size_ = 1u;      
  size_t erase_block_count_ = 0u;     
  uint8_t* erased_blocks_ = nullptr;  
  size_t seal_storage_size_ = 0u;     
  uint8_t* seal_storage_ = nullptr;   
  size_t transfer_size_ = 0u;         
  uint8_t* write_buffer_ = nullptr;   
  uint8_t crc_buffer_[256] = {};      
  DownloadState download_ = {};       
  WriteState write_ = {};             
  ManifestState manifest_ = {};       
  UploadState upload_ = {};           
};
 
template <typename Backend, size_t MAX_TRANSFER_SIZE = 4096u>
class DFUClass : public DfuInterfaceClassBase
{
  static_assert(MAX_TRANSFER_SIZE > 0u, "DFU transfer size must be non-zero.");
  static_assert(MAX_TRANSFER_SIZE <= 0xFFFFu,
                "DFU transfer size must fit in wTransferSize.");
 
  static constexpr uint8_t INTERFACE_CLASS = 0xFEu;
  static constexpr uint8_t INTERFACE_SUB_CLASS = 0x01u;
  static constexpr uint8_t INTERFACE_PROTOCOL = 0x02u;
  static constexpr uint16_t DFU_VERSION = 0x0110u;
 
  static constexpr uint8_t ATTR_CAN_DOWNLOAD = 0x01u;
  static constexpr uint8_t ATTR_CAN_UPLOAD = 0x02u;
  static constexpr uint8_t ATTR_MANIFESTATION_TOLERANT = 0x04u;
  static constexpr uint8_t ATTR_WILL_DETACH = 0x08u;
 
 public:
  LIBXR_PACKED_BEGIN
  struct FunctionalDescriptor
  {
    uint8_t bLength = 9;
    uint8_t bDescriptorType = 0x21;
    uint8_t bmAttributes = 0;
    uint16_t wDetachTimeOut = 0;
    uint16_t wTransferSize = 0;
    uint16_t bcdDFUVersion = DFU_VERSION;
  };
 
  struct StatusResponse
  {
    uint8_t bStatus = 0;
    uint8_t bwPollTimeout[3] = {0, 0, 0};
    uint8_t bState = 0;
    uint8_t iString = 0;
 
    void SetPollTimeout(uint32_t timeout_ms)
    {
      bwPollTimeout[0] = static_cast<uint8_t>(timeout_ms & 0xFFu);
      bwPollTimeout[1] = static_cast<uint8_t>((timeout_ms >> 8) & 0xFFu);
      bwPollTimeout[2] = static_cast<uint8_t>((timeout_ms >> 16) & 0xFFu);
    }
  };
 
  struct DescriptorBlock
  {
    ConfigDescriptorItem::InterfaceDescriptor interface_desc = {
        9,
        static_cast<uint8_t>(DescriptorType::INTERFACE),
        0,
        0,
        0,
        INTERFACE_CLASS,
        INTERFACE_SUB_CLASS,
        INTERFACE_PROTOCOL,
        0};
    FunctionalDescriptor func_desc = {};
  };
  LIBXR_PACKED_END
 
  static_assert(sizeof(FunctionalDescriptor) == 9,
                "DFU functional descriptor size mismatch.");
  static_assert(sizeof(StatusResponse) == 6, "DFU status response size mismatch.");
 
 public:
  static constexpr const char* DEFAULT_INTERFACE_STRING = "XRUSB DFU";
  static constexpr const char* DEFAULT_WINUSB_DEVICE_INTERFACE_GUID =
      DfuInterfaceClassBase::DEFAULT_WINUSB_DEVICE_INTERFACE_GUID;
  static constexpr uint8_t DEFAULT_WINUSB_VENDOR_CODE =
      DfuInterfaceClassBase::DEFAULT_WINUSB_VENDOR_CODE;
 
  explicit DFUClass(
      Backend& backend, const char* interface_string = DEFAULT_INTERFACE_STRING,
      const char* webusb_landing_page_url = nullptr,
      uint8_t webusb_vendor_code = LibXR::USB::WebUsb::WEBUSB_VENDOR_CODE_DEFAULT,
      const char* winusb_device_interface_guid = DEFAULT_WINUSB_DEVICE_INTERFACE_GUID,
      uint8_t winusb_vendor_code = DEFAULT_WINUSB_VENDOR_CODE)
      : DfuInterfaceClassBase(interface_string, webusb_landing_page_url,
                              webusb_vendor_code, winusb_device_interface_guid,
                              winusb_vendor_code),
        backend_(backend)
  {
  }
 
 protected:
  void BindEndpoints(EndpointPool&, uint8_t start_itf_num, bool) override
  {
    // 固件态 DFU 在绑定阶段发布单接口描述符，并校验 backend 能力。
    // Firmware DFU publishes one interface and validates backend capabilities during
    // bind.
    interface_num_ = start_itf_num;
    current_alt_setting_ = 0u;
 
    caps_ = backend_.GetDfuCapabilities();
    if (caps_.transfer_size == 0u || caps_.transfer_size > MAX_TRANSFER_SIZE)
    {
      caps_.transfer_size = static_cast<uint16_t>(MAX_TRANSFER_SIZE);
    }
 
    desc_block_.interface_desc.bInterfaceNumber = interface_num_;
    desc_block_.interface_desc.bAlternateSetting = 0u;
    desc_block_.interface_desc.iInterface = GetInterfaceStringIndex(0u);
    desc_block_.func_desc.bmAttributes = BuildAttributeBitmap(caps_);
    desc_block_.func_desc.wDetachTimeOut = caps_.detach_timeout_ms;
    desc_block_.func_desc.wTransferSize = caps_.transfer_size;
    desc_block_.func_desc.bcdDFUVersion = DFU_VERSION;
 
    SetData(RawData{reinterpret_cast<uint8_t*>(&desc_block_), sizeof(desc_block_)});
 
    ResetProtocolState();
    auto ec = backend_.DfuSetAlternate(current_alt_setting_);
    if (ec != ErrorCode::OK)
    {
      inited_ = false;
      return;
    }
    inited_ = true;
  }
 
  void UnbindEndpoints(EndpointPool&, bool) override
  {
    if (inited_)
    {
      // 解绑时先把 backend 置回 abort 状态，
      // 这样下一次绑定总是从干净的协议会话开始。
      // Unbind must leave the backend in an aborted state so the next bind
      // always starts from a clean protocol session.
      backend_.DfuAbort(current_alt_setting_);
    }
    inited_ = false;
    ResetProtocolState();
  }
 
  size_t GetInterfaceCount() override { return 1u; }
  bool HasIAD() override { return false; }
  size_t GetMaxConfigSize() override { return sizeof(desc_block_); }
  ErrorCode WriteDeviceDescriptor(DeviceDescriptor& header) override
  {
    header.data_.bDeviceClass = DeviceDescriptor::ClassID::APPLICATION_SPECIFIC;
    header.data_.bDeviceSubClass = INTERFACE_SUB_CLASS;
    header.data_.bDeviceProtocol = INTERFACE_PROTOCOL;
    return ErrorCode::OK;
  }
 
  ErrorCode SetAltSetting(uint8_t itf, uint8_t alt) override
  {
    if (itf != interface_num_)
    {
      return ErrorCode::NOT_FOUND;
    }
    if (alt != 0u)
    {
      return ErrorCode::NOT_SUPPORT;
    }
    if (state_ == DFUState::DFU_DNBUSY || state_ == DFUState::DFU_MANIFEST ||
        state_ == DFUState::DFU_MANIFEST_WAIT_RESET)
    {
      // 协议仍处于非空闲阶段时，不允许切换 alternate setting。
      // Alternate setting cannot change while the protocol is in a non-idle phase.
      return ErrorCode::BUSY;
    }
 
    auto ec = backend_.DfuSetAlternate(alt);
    if (ec != ErrorCode::OK)
    {
      return ec;
    }
 
    backend_.DfuAbort(current_alt_setting_);
    current_alt_setting_ = alt;
    ClearErrorState();
    return ErrorCode::OK;
  }
 
  ErrorCode GetAltSetting(uint8_t itf, uint8_t& alt) override
  {
    if (itf != interface_num_)
    {
      return ErrorCode::NOT_FOUND;
    }
    alt = current_alt_setting_;
    return ErrorCode::OK;
  }
 
  ErrorCode OnGetDescriptor(bool, uint8_t, uint16_t wValue, uint16_t,
                            ConstRawData& out_data) override
  {
    const uint8_t desc_type = static_cast<uint8_t>((wValue >> 8) & 0xFFu);
    if (desc_type != desc_block_.func_desc.bDescriptorType)
    {
      return ErrorCode::NOT_SUPPORT;
    }
 
    out_data = {reinterpret_cast<const uint8_t*>(&desc_block_.func_desc),
                sizeof(desc_block_.func_desc)};
    return ErrorCode::OK;
  }
 
  ErrorCode OnClassRequest(bool, uint8_t bRequest, uint16_t wValue, uint16_t wLength,
                           uint16_t wIndex, ControlTransferResult& result) override
  {
    if (!inited_)
    {
      return ErrorCode::INIT_ERR;
    }
    if ((wIndex & 0xFFu) != interface_num_)
    {
      return ErrorCode::NOT_FOUND;
    }
 
    switch (static_cast<DFURequest>(bRequest))
    {
      case DFURequest::DETACH:
        return HandleDetach(result);
 
      case DFURequest::DNLOAD:
        return HandleDnload(wValue, wLength, result);
 
      case DFURequest::UPLOAD:
        return HandleUpload(wValue, wLength, result);
 
      case DFURequest::GETSTATUS:
        return HandleGetStatus(result);
 
      case DFURequest::CLRSTATUS:
        return HandleClearStatus(result);
 
      case DFURequest::GETSTATE:
        return HandleGetState(result);
 
      case DFURequest::ABORT:
        return HandleAbort(result);
 
      default:
        return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
  }
 
  ErrorCode OnClassData(bool, uint8_t bRequest, LibXR::ConstRawData& data) override
  {
    const auto request = static_cast<DFURequest>(bRequest);
    UNUSED(data);
 
    if (request != DFURequest::DNLOAD)
    {
      return ErrorCode::NOT_SUPPORT;
    }
 
    if (pending_dnload_length_ == 0u)
    {
      // 这里出现零长度 OUT data stage 只在“DNLOAD 已结束”的路径上才是合法的。
      // A zero-length OUT data stage is legal here only for the already-finished
      // DNLOAD path.
      return ErrorCode::OK;
    }
 
    uint32_t poll_timeout_ms = 0u;
    auto status = backend_.DfuDownload(current_alt_setting_, pending_block_num_, data,
                                       poll_timeout_ms);
    pending_dnload_length_ = 0u;
    poll_timeout_ms_ = poll_timeout_ms;
 
    if (status == DFUStatusCode::OK)
    {
      state_ = DFUState::DFU_DNLOAD_SYNC;
      status_ = DFUStatusCode::OK;
      download_started_ = true;
    }
    else
    {
      EnterErrorState(status);
    }
    return ErrorCode::OK;
  }
 
  void OnClassInDataStatusComplete(bool, uint8_t bRequest) override
  {
    if (static_cast<DFURequest>(bRequest) != DFURequest::GETSTATUS)
    {
      return;
    }
    if (state_ == DFUState::DFU_MANIFEST_WAIT_RESET)
    {
      // 只有在主机完成了报告 MANIFEST-WAIT-RESET 的那笔 GETSTATUS 的 STATUS OUT 后，
      // 才真正提交 autorun。
      // Commit autorun only after the host completes the STATUS OUT of the
      // GETSTATUS request that reported MANIFEST-WAIT-RESET.
      backend_.DfuCommitManifestWaitReset(current_alt_setting_);
    }
  }
 
 private:
  static constexpr uint8_t BuildAttributeBitmap(const DFUCapabilities& caps)
  {
    return static_cast<uint8_t>(
        (caps.can_download ? ATTR_CAN_DOWNLOAD : 0u) |
        (caps.can_upload ? ATTR_CAN_UPLOAD : 0u) |
        (caps.manifestation_tolerant ? ATTR_MANIFESTATION_TOLERANT : 0u) |
        (caps.will_detach ? ATTR_WILL_DETACH : 0u));
  }
 
  ErrorCode HandleDetach(ControlTransferResult&)
  {
    // 固件态 DFU 不实现 DETACH；该请求由 runtime DFU 处理。
    // Firmware-mode DFU does not implement DETACH; runtime DFU owns that request.
    return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
  }
 
  ErrorCode HandleDnload(uint16_t block_num, uint16_t wLength,
                         ControlTransferResult& result)
  {
    if (!caps_.can_download)
    {
      return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
    if (!(state_ == DFUState::DFU_IDLE || state_ == DFUState::DFU_DNLOAD_IDLE))
    {
      return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
    if (wLength > caps_.transfer_size)
    {
      return ProtocolStall(DFUStatusCode::ERR_USBR);
    }
 
    if (wLength == 0u)
    {
      // 零长度 DNLOAD 表示结束数据阶段并进入 manifest，
      // 但前提是之前至少成功接收过一个 payload block。
      // A zero-length DNLOAD terminates the data phase and requests manifest,
      // but only after at least one payload block was accepted.
      pending_dnload_length_ = 0u;
      pending_block_num_ = block_num;
      if (!download_started_)
      {
        EnterErrorState(DFUStatusCode::ERR_NOTDONE);
      }
      else
      {
        state_ = DFUState::DFU_MANIFEST_SYNC;
        status_ = DFUStatusCode::OK;
        poll_timeout_ms_ = 0u;
      }
      result.SendStatusInZLP() = true;
      return ErrorCode::OK;
    }
 
    pending_block_num_ = block_num;
    pending_dnload_length_ = wLength;
    result.OutData() = {transfer_buffer_, wLength};
    return ErrorCode::OK;
  }
 
  ErrorCode HandleUpload(uint16_t block_num, uint16_t wLength,
                         ControlTransferResult& result)
  {
    if (!caps_.can_upload)
    {
      return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
    if (!(state_ == DFUState::DFU_IDLE || state_ == DFUState::DFU_UPLOAD_IDLE))
    {
      return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
    if (wLength == 0u)
    {
      return ProtocolStall(DFUStatusCode::ERR_USBR);
    }
 
    size_t req_size = wLength;
    if (req_size > caps_.transfer_size)
    {
      req_size = caps_.transfer_size;
    }
 
    DFUStatusCode op_status = DFUStatusCode::OK;
    uint32_t poll_timeout_ms = 0u;
    const size_t read_size =
        backend_.DfuUpload(current_alt_setting_, block_num, {transfer_buffer_, req_size},
                           op_status, poll_timeout_ms);
 
    poll_timeout_ms_ = poll_timeout_ms;
    if (op_status != DFUStatusCode::OK)
    {
      return ProtocolStall(op_status);
    }
    if (read_size > req_size)
    {
      return ProtocolStall(DFUStatusCode::ERR_USBR);
    }
 
    status_ = DFUStatusCode::OK;
    state_ = (read_size < req_size) ? DFUState::DFU_IDLE : DFUState::DFU_UPLOAD_IDLE;
    result.InData() = {transfer_buffer_, read_size};
    return ErrorCode::OK;
  }
 
  ErrorCode HandleGetStatus(ControlTransferResult& result)
  {
    AdvanceStateForStatusRead();
    status_response_.bStatus = static_cast<uint8_t>(status_);
    status_response_.SetPollTimeout(poll_timeout_ms_);
    status_response_.bState = static_cast<uint8_t>(state_);
    status_response_.iString = 0u;
    result.InData() = {reinterpret_cast<const uint8_t*>(&status_response_),
                       sizeof(status_response_)};
    return ErrorCode::OK;
  }
 
  ErrorCode HandleClearStatus(ControlTransferResult& result)
  {
    if (state_ != DFUState::DFU_ERROR)
    {
      return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
    backend_.DfuClearStatus(current_alt_setting_);
    ClearErrorState();
    result.SendStatusInZLP() = true;
    return ErrorCode::OK;
  }
 
  ErrorCode HandleGetState(ControlTransferResult& result)
  {
    state_response_ = static_cast<uint8_t>(state_);
    result.InData() = {&state_response_, sizeof(state_response_)};
    return ErrorCode::OK;
  }
 
  ErrorCode HandleAbort(ControlTransferResult& result)
  {
    switch (state_)
    {
      case DFUState::DFU_IDLE:
      case DFUState::DFU_DNLOAD_SYNC:
      case DFUState::DFU_DNLOAD_IDLE:
      case DFUState::DFU_UPLOAD_IDLE:
      case DFUState::DFU_MANIFEST_SYNC:
        backend_.DfuAbort(current_alt_setting_);
        ClearErrorState();
        result.SendStatusInZLP() = true;
        return ErrorCode::OK;
 
      default:
        return ProtocolStall(DFUStatusCode::ERR_STALLEDPKT);
    }
  }
 
  void AdvanceStateForStatusRead()
  {
    // 标准 DFU 状态机是在 GETSTATUS 这个同步点上推进的。
    // GETSTATUS is the synchronization point that advances the standard DFU state
    // machine.
    switch (state_)
    {
      case DFUState::DFU_DNLOAD_SYNC:
        RefreshDownloadStatus();
        break;
 
      case DFUState::DFU_MANIFEST_SYNC:
      {
        if (status_ != DFUStatusCode::OK)
        {
          state_ = DFUState::DFU_ERROR;
          break;
        }
 
        uint32_t poll_timeout_ms = 0u;
        auto manifest_status =
            backend_.DfuManifest(current_alt_setting_, poll_timeout_ms);
        poll_timeout_ms_ = poll_timeout_ms;
        if (manifest_status == DFUStatusCode::OK)
        {
          status_ = DFUStatusCode::OK;
          state_ = DFUState::DFU_MANIFEST;
        }
        else
        {
          EnterErrorState(manifest_status);
        }
        break;
      }
 
      case DFUState::DFU_DNBUSY:
        RefreshDownloadStatus();
        break;
 
      case DFUState::DFU_MANIFEST:
        RefreshManifestStatus();
        break;
 
      default:
        break;
    }
  }
 
  void RefreshDownloadStatus()
  {
    if (status_ != DFUStatusCode::OK)
    {
      state_ = DFUState::DFU_ERROR;
      return;
    }
 
    bool busy = false;
    uint32_t poll_timeout_ms = 0u;
    const auto download_status =
        backend_.DfuGetDownloadStatus(current_alt_setting_, busy, poll_timeout_ms);
    poll_timeout_ms_ = poll_timeout_ms;
    if (download_status != DFUStatusCode::OK)
    {
      EnterErrorState(download_status);
      return;
    }
 
    // backend 报 busy 时映射到 DFU_DNBUSY；
    // 否则主机可以从 DFU_DNLOAD_IDLE 继续发送下一块 DNLOAD。
    // A backend-reported busy maps to DFU_DNBUSY; otherwise the host may
    // continue sending the next DNLOAD block from DFU_DNLOAD_IDLE.
    state_ = busy ? DFUState::DFU_DNBUSY : DFUState::DFU_DNLOAD_IDLE;
  }
 
  void RefreshManifestStatus()
  {
    if (status_ != DFUStatusCode::OK)
    {
      state_ = DFUState::DFU_ERROR;
      return;
    }
 
    bool busy = false;
    uint32_t poll_timeout_ms = 0u;
    const auto manifest_status =
        backend_.DfuGetManifestStatus(current_alt_setting_, busy, poll_timeout_ms);
    poll_timeout_ms_ = poll_timeout_ms;
    if (manifest_status != DFUStatusCode::OK)
    {
      EnterErrorState(manifest_status);
      return;
    }
 
    if (busy)
    {
      state_ = DFUState::DFU_MANIFEST;
      return;
    }
 
    // manifest 完成后，要么回到 IDLE（tolerant），要么进入 WAIT_RESET（non-tolerant）。
    // Manifest completion returns either to IDLE (tolerant) or WAIT_RESET (non-tolerant).
    download_started_ = false;
    state_ = caps_.manifestation_tolerant ? DFUState::DFU_IDLE
                                          : DFUState::DFU_MANIFEST_WAIT_RESET;
  }
 
  void ResetProtocolState()
  {
    // 这里只重置前端拥有的协议状态；
    // 镜像级 bookkeeping 保留在 backend_ 里。
    // Reset only frontend-owned protocol state;
    // image-level bookkeeping stays in backend_.
    pending_block_num_ = 0u;
    pending_dnload_length_ = 0u;
    poll_timeout_ms_ = 0u;
    current_alt_setting_ = 0u;
    download_started_ = false;
    ClearErrorState();
  }
 
  void ClearErrorState()
  {
    status_ = DFUStatusCode::OK;
    state_ = DFUState::DFU_IDLE;
    poll_timeout_ms_ = 0u;
  }
 
  void EnterErrorState(DFUStatusCode status)
  {
    // 一旦锁存错误，前端会保持在 DFU_ERROR，
    // 直到 CLRSTATUS/ABORT 把它清掉。
    // Once an error is latched, the frontend stays in DFU_ERROR
    // until CLRSTATUS/ABORT clears it.
    status_ = status;
    state_ = DFUState::DFU_ERROR;
    poll_timeout_ms_ = 0u;
  }
 
  ErrorCode ProtocolStall(DFUStatusCode status)
  {
    EnterErrorState(status);
    return ErrorCode::ARG_ERR;
  }
 
 private:
  Backend& backend_;                     
  DFUCapabilities caps_ = {};            
  DescriptorBlock desc_block_ = {};      
  StatusResponse status_response_ = {};  
  uint8_t state_response_ = 0u;          
  uint8_t transfer_buffer_[MAX_TRANSFER_SIZE] =
      {};                          
  bool download_started_ = false;  
  uint16_t pending_block_num_ = 0u;      
  uint16_t pending_dnload_length_ = 0u;  
  uint32_t poll_timeout_ms_ = 0u;        
  DFUState state_ = DFUState::DFU_IDLE;  
  DFUStatusCode status_ = DFUStatusCode::OK;  
};
 
class DfuBootloaderClassStorage
{
 protected:
  using JumpCallback = DfuBootloaderBackend::JumpCallback;
 
  DfuBootloaderClassStorage(Flash& flash, size_t image_base, size_t image_limit,
                            size_t seal_offset, JumpCallback jump_to_app,
                            void* jump_app_ctx = nullptr, bool autorun = true)
      : backend_(flash, image_base, image_limit, seal_offset, jump_to_app, jump_app_ctx,
                 autorun),
        image_base_(image_base),
        image_limit_(image_limit),
        seal_offset_(seal_offset)
  {
  }
 
  DfuBootloaderBackend backend_;
  size_t image_base_ = 0u;
  size_t image_limit_ = 0u;
  size_t seal_offset_ = 0u;
};
 
template <size_t MAX_TRANSFER_SIZE = 4096u>
class DfuBootloaderClassT : private DfuBootloaderClassStorage,
                            public DFUClass<DfuBootloaderBackend, MAX_TRANSFER_SIZE>
{
  using Storage = DfuBootloaderClassStorage;
  using Base = DFUClass<DfuBootloaderBackend, MAX_TRANSFER_SIZE>;
 
 public:
  using JumpCallback = DfuBootloaderBackend::JumpCallback;
  static constexpr uint8_t VENDOR_REQUEST_RUN_APP = 0x5Au;
 
  DfuBootloaderClassT(
      Flash& flash, size_t image_base, size_t image_limit, size_t seal_offset,
      JumpCallback jump_to_app, void* jump_app_ctx = nullptr, bool autorun = true,
      const char* interface_string = Base::DEFAULT_INTERFACE_STRING,
      const char* webusb_landing_page_url = nullptr,
      uint8_t webusb_vendor_code = LibXR::USB::WebUsb::WEBUSB_VENDOR_CODE_DEFAULT,
      const char* winusb_device_interface_guid =
          Base::DEFAULT_WINUSB_DEVICE_INTERFACE_GUID,
      uint8_t winusb_vendor_code = Base::DEFAULT_WINUSB_VENDOR_CODE)
      : Storage(flash, image_base, image_limit, seal_offset, jump_to_app, jump_app_ctx,
                autorun),
        Base(Storage::backend_, interface_string, webusb_landing_page_url,
             webusb_vendor_code, winusb_device_interface_guid, winusb_vendor_code)
  {
  }
 
  // 这里只推进 backend 拥有的异步工作；真正跳 app 仍保持显式调用。
  // Process only backend-owned async work; actual app launch remains explicit.
  void Process() { Storage::backend_.Process(); }
  bool RequestRunApp() { return Storage::backend_.TryRequestRunApp(); }
 
  bool TryConsumeAppLaunch(uint32_t now_ms)
  {
    return Storage::backend_.TryConsumeAppLaunch(now_ms);
  }
 
  bool HasPendingWork() const { return Storage::backend_.HasPendingWork(); }
  bool HasValidImage() const { return Storage::backend_.HasValidImage(); }
  size_t ImageSize() const { return Storage::backend_.ImageSize(); }
  size_t ImageBase() const { return Storage::image_base_; }
  size_t ImageLimit() const { return Storage::image_limit_; }
  size_t SealOffset() const { return Storage::seal_offset_; }
 
 protected:
  ErrorCode OnVendorRequest(bool, uint8_t bRequest, uint16_t wValue, uint16_t wLength,
                            uint16_t,
                            typename Base::ControlTransferResult& result) override
  {
    if (bRequest != VENDOR_REQUEST_RUN_APP)
    {
      return ErrorCode::NOT_SUPPORT;
    }
    if (wLength != 0u || wValue != 0u)
    {
      return ErrorCode::ARG_ERR;
    }
    if (Storage::backend_.HasPendingWork())
    {
      // 协议拥有的异步工作尚未完成时，不允许启动 app。
      // Do not launch the app while protocol-owned async work is still pending.
      return ErrorCode::BUSY;
    }
    if (!Storage::backend_.TryRequestRunApp())
    {
      // RUN_APP 只在已知存在有效 seal 镜像时才会接受。
      // RUN_APP is only accepted when a valid sealed image is known.
      return ErrorCode::FAILED;
    }
    result.SendStatusInZLP() = true;
    return ErrorCode::OK;
  }
};
 
using DfuBootloaderClass = DfuBootloaderClassT<4096u>;
 
}  // namespace LibXR::USB