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 122 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)
{
  // `Flash` 基类看到的是从 `start_sector` 开始的一整段连续逻辑窗口，
  // `sectors_` 仍保留原始物理扇区表，用于范围检查和地址换算。
  // The `Flash` base class sees one contiguous logical window starting at
  // `start_sector`, while `sectors_` still preserves the physical sector table
  // for bounds checks and address translation.
  InitHotPathsOnce();
}

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 120 of file ch32_flash.cpp.

{ flash_clear_flags_once(); }

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 139 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);
  const auto erase_hot_path = g_ch32_flash_hot_paths.erase;
  ASSERT(erase_hot_path != nullptr);
  FlashAccessSession session;
 
  // 当前已验证的 CH32V2/V3 快速擦除路径都按 256B 页对齐工作，
  // 因此子页范围的擦除请求进入 SRAM 热路径前必须先扩到整页边界。
  // The currently validated CH32V2/V3 fast erase path works on 256-byte pages,
  // so a sub-page erase request must be widened to page boundaries before
  // entering the SRAM hot path.
  const uint32_t fast_size = 256u;
  const uint32_t ERASE_BEGIN = START_ADDR & ~(fast_size - 1u);
  const uint32_t ERASE_END = (END_ADDR + fast_size - 1u) & ~(fast_size - 1u);
  if (ERASE_END <= ERASE_BEGIN)
  {
    return ErrorCode::OK;
  }
 
  return erase_hot_path(ERASE_BEGIN, ERASE_END);
}

IsInRange()

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

private

Definition at line 245 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 174 of file ch32_flash.cpp.

{
  ASSERT(SystemCoreClock <= 120000000);
 
  if (!data.addr_ || data.size_ == 0)
  {
    ASSERT(false);
    return ErrorCode::ARG_ERR;
  }
 
  const uint32_t START_ADDR = base_address_ + static_cast<uint32_t>(offset);
  if (!IsInRange(START_ADDR, data.size_))
  {
    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_);
  return CH32FlashWriteHotPath(START_ADDR, END_ADDR, src);
}

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