LibXR::CH32Flash Class Reference

CH32 闪存驱动实现 / CH32 flash driver implementation. More...

#include <ch32_flash.hpp>

Inheritance diagram for LibXR::CH32Flash:

Collaboration diagram for LibXR::CH32Flash:

Public Member Functions
	CH32Flash (const FlashSector *sectors, size_t sector_count, size_t start_sector)
	构造闪存对象 / Construct flash object
	CH32Flash (const FlashSector *sectors, size_t sector_count)
	构造并使用默认起始扇区 / Construct with default start sector
ErrorCode	Erase (size_t offset, size_t size) override
	Erases a section of the flash memory. 擦除闪存的指定区域。
ErrorCode	Write (size_t offset, ConstRawData data) override
	Writes data to the flash memory. 向闪存写入数据。
Public Member Functions inherited from LibXR::Flash
	Flash (size_t min_erase_size, size_t min_write_size, RawData flash_area)
	Constructs a Flash object with specified properties. 构造函数，初始化闪存属性。
virtual ErrorCode	Read (size_t offset, RawData data)
	Reads data from the flash memory. 从闪存中读取数据。
size_t	MinEraseSize () const
	Returns the minimum erasable block size in bytes. 获取最小可擦除块大小（字节）。
size_t	MinWriteSize () const
	Returns the minimum writable block size in bytes. 获取最小可写块大小（字节）。
size_t	Size () const
	Returns the size of the flash memory area. 获取闪存存储区域的大小。

Static Public Member Functions
static constexpr size_t	MinWriteSize ()
	最小写入粒度（半字） / Minimum write size (half-word)
static constexpr uint32_t	PageSize ()
	Page erase size in fast erase mode / 快速擦除页大小

Private Member Functions
bool	IsInRange (uint32_t addr, size_t size) const

Static Private Member Functions
static void	ClearFlashFlagsOnce ()

Private Attributes
const FlashSector *	sectors_
uint32_t	base_address_
size_t	sector_count_

Detailed Description

CH32 闪存驱动实现 / CH32 flash driver implementation.

Definition at line 23 of file ch32_flash.hpp.

Constructor & Destructor Documentation

CH32Flash() [1/2]

CH32Flash::CH32Flash	(	const FlashSector *	sectors,
		size_t	sector_count,
		size_t	start_sector )

构造闪存对象 / Construct flash object

Definition at line 69 of file ch32_flash.cpp.

    : Flash(sectors[start_sector - 1].size, MinWriteSize(),
            {reinterpret_cast<void*>(sectors[start_sector - 1].address),
             sectors[sector_count - 1].address - sectors[start_sector - 1].address +
                 sectors[sector_count - 1].size}),
      sectors_(sectors),
      base_address_(sectors[start_sector - 1].address),
      sector_count_(sector_count)
{
}

CH32Flash() [2/2]

LibXR::CH32Flash::CH32Flash ( const FlashSector * sectors, size_t sector_count )

inline

构造并使用默认起始扇区 / Construct with default start sector

Definition at line 33 of file ch32_flash.hpp.

      : CH32Flash(sectors, sector_count, sector_count - 1)
  {
  }

Member Function Documentation

ClearFlashFlagsOnce()

void CH32Flash::ClearFlashFlagsOnce ( )

inlinestaticprivate

Definition at line 60 of file ch32_flash.cpp.

{
#ifdef FLASH_FLAG_BSY
  FLASH_ClearFlag(FLASH_FLAG_BSY | FLASH_FLAG_EOP | FLASH_FLAG_WRPRTERR);
#else
  FLASH_ClearFlag(FLASH_FLAG_EOP | FLASH_FLAG_WRPRTERR);
#endif
}

Erase()

ErrorCode CH32Flash::Erase ( size_t offset, size_t size )

overridevirtual

Erases a section of the flash memory. 擦除闪存的指定区域。

Parameters

offset	The starting offset of the section to erase. 要擦除的起始偏移地址。
size	The size of the section to erase. 要擦除的区域大小。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::Flash.

Definition at line 80 of file ch32_flash.cpp.

{
  if (size == 0)
  {
    return ErrorCode::ARG_ERR;
  }
 
  ASSERT(SystemCoreClock <= 120000000);
 
  const uint32_t START_ADDR = base_address_ + static_cast<uint32_t>(offset);
  if (!IsInRange(START_ADDR, size))
  {
    return ErrorCode::OUT_OF_RANGE;
  }
  const uint32_t END_ADDR = START_ADDR + static_cast<uint32_t>(size);
 
  // 1) 退出增强读模式
  flash_exit_enhanced_read_if_enabled();  // 进入擦写前必须退出 EHMOD
 
  // 2) 访问时钟降为 SYSCLK/2（SCKMOD=0）
  flash_set_access_clock_half_sysclk();
 
  // 3) 解锁：常规 + 快速模式
  flash_fast_unlock();
  ClearFlashFlagsOnce();
 
  // 4) 计算 256B 对齐区间
  const uint32_t FAST_SZ = 256u;
  const uint32_t ERASE_BEGIN = START_ADDR & ~(FAST_SZ - 1u);
  const uint32_t ERASE_END = (END_ADDR + FAST_SZ - 1u) & ~(FAST_SZ - 1u);
  if (ERASE_END <= ERASE_BEGIN)
  {
    flash_fast_lock();
    flash_set_access_clock_sysclk();
    return ErrorCode::OK;
  }
 
  // 5) 开启快速页擦除：CTLR.FTER=1
  FLASH->CTLR |= (1u << 17);
 
  // 6) 逐页(256B)擦除
  for (uint32_t adr = ERASE_BEGIN; adr < ERASE_END; adr += FAST_SZ)
  {
    // 写入页首地址
    FLASH->ADDR = adr;
 
    // 触发 STRT
    FLASH->CTLR |= (1u << 6);
 
    // 等待 BSY=0
    if (!flash_wait_busy_clear())
    {
      // 关闭 FTER & 复锁 & 还原时钟后返回
      FLASH->CTLR &= ~(1u << 17);
      flash_fast_lock();
      flash_set_access_clock_sysclk();
      return ErrorCode::FAILED;
    }
 
    // 检查错误并清标志
    if (FLASH->STATR & (1u << 4))
    {  // WRPRTERR
      FLASH_ClearFlag(FLASH_FLAG_EOP | FLASH_FLAG_WRPRTERR);
      FLASH->CTLR &= ~(1u << 17);
      flash_fast_lock();
      flash_set_access_clock_sysclk();
      return ErrorCode::FAILED;
    }
 
    // 成功：清 EOP
    FLASH_ClearFlag(FLASH_FLAG_EOP);
  }
 
  // 7) 关闭快速页擦除位，复锁快速模式与常规锁，并恢复访问时钟
  FLASH->CTLR &= ~(1u << 17);  // FTER=0
  flash_fast_lock();
  flash_set_access_clock_sysclk();
 
  return ErrorCode::OK;
}

IsInRange()

bool CH32Flash::IsInRange ( uint32_t addr, size_t size ) const

private

Definition at line 244 of file ch32_flash.cpp.

{
  const uint32_t BEGIN = base_address_;
  const uint32_t LIMIT =
      sectors_[sector_count_ - 1].address + sectors_[sector_count_ - 1].size;
  const uint32_t END = addr + static_cast<uint32_t>(size);
  return (addr >= BEGIN) && (END <= LIMIT) && (END >= addr);
}

MinWriteSize()

static constexpr size_t LibXR::CH32Flash::MinWriteSize ( )

inlinestaticconstexpr

最小写入粒度（半字） / Minimum write size (half-word)

Definition at line 41 of file ch32_flash.hpp.

PageSize()

static constexpr uint32_t LibXR::CH32Flash::PageSize ( )

inlinestaticconstexpr

Page erase size in fast erase mode / 快速擦除页大小

Definition at line 46 of file ch32_flash.hpp.

Write()

ErrorCode CH32Flash::Write ( size_t offset, ConstRawData data )

overridevirtual

Writes data to the flash memory. 向闪存写入数据。

Parameters

offset	The starting offset to write data. 数据写入的起始偏移地址。
data	The data to be written. 需要写入的数据。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::Flash.

Definition at line 161 of file ch32_flash.cpp.

{
  ASSERT(SystemCoreClock <= 120000000);
 
  // 退出增强读模式 → 减少失败风险（手册要求在编程/擦除前退出）
  flash_exit_enhanced_read_if_enabled();
 
  // 访问时钟切半（SCKMOD=0）
  flash_set_access_clock_half_sysclk();
 
  if (!data.addr_ || data.size_ == 0)
  {
    flash_set_access_clock_sysclk();
    ASSERT(false);
    return ErrorCode::ARG_ERR;
  }
 
  const uint32_t START_ADDR = base_address_ + static_cast<uint32_t>(offset);
  if (!IsInRange(START_ADDR, data.size_))
  {
    flash_set_access_clock_sysclk();
    ASSERT(false);
    return ErrorCode::OUT_OF_RANGE;
  }
 
  const uint8_t* src = reinterpret_cast<const uint8_t*>(data.addr_);
  const uint32_t END_ADDR = START_ADDR + static_cast<uint32_t>(data.size_);
 
  FLASH_Unlock();
  ClearFlashFlagsOnce();
 
  const uint32_t HW_BEGIN = START_ADDR & ~1u;
  const uint32_t HW_END = (END_ADDR + 1u) & ~1u;  // 向上取整到半字
 
  for (uint32_t hw = HW_BEGIN; hw < HW_END; hw += 2u)
  {
    volatile uint16_t* p = reinterpret_cast<volatile uint16_t*>(hw);
    volatile uint16_t orig = *p;
    volatile uint16_t val = orig;
 
    if (hw >= START_ADDR && hw < END_ADDR)
    {
      uint8_t b0 = src[hw - START_ADDR];
      val = static_cast<uint16_t>((val & 0xFF00u) | b0);
    }
    if ((hw + 1u) >= START_ADDR && (hw + 1u) < END_ADDR)
    {
      uint8_t b1 = src[(hw + 1u) - START_ADDR];
      val = static_cast<uint16_t>((val & 0x00FFu) | (static_cast<uint16_t>(b1) << 8));
    }
 
    if (val == orig)
    {
      continue;  // 无变化
    }
 
    // 未擦除单元禁止 0->1 抬位
    if (((~orig) & val) != 0u && orig != 0xE339u)
    {
      FLASH_Lock();
      flash_set_access_clock_sysclk();
      ASSERT(false);
      return ErrorCode::FAILED;
    }
 
    if (FLASH_ProgramHalfWord(hw, val) != FLASH_COMPLETE)
    {
      FLASH_Lock();
      flash_set_access_clock_sysclk();
      ASSERT(false);
      return ErrorCode::FAILED;
    }
 
    ASSERT(*p == val);
 
    FLASH_ClearFlag(FLASH_FLAG_EOP | FLASH_FLAG_WRPRTERR);
  }
 
  FLASH_Lock();
  flash_set_access_clock_sysclk();
  return ErrorCode::OK;
}

Field Documentation

base_address_

uint32_t LibXR::CH32Flash::base_address_

private

Definition at line 53 of file ch32_flash.hpp.

sector_count_

size_t LibXR::CH32Flash::sector_count_

private

Definition at line 54 of file ch32_flash.hpp.

sectors_

const FlashSector* LibXR::CH32Flash::sectors_

private

Definition at line 52 of file ch32_flash.hpp.

---

The documentation for this class was generated from the following files:

• driver/ch/ch32_flash.hpp
• driver/ch/ch32_flash.cpp