LibXR::STM32Flash Class Reference

STM32Flash 通用类，构造时传入扇区列表，自动判断编程粒度。 More...

#include <stm32_flash.hpp>

Inheritance diagram for LibXR::STM32Flash:

Collaboration diagram for LibXR::STM32Flash:

Public Member Functions
	STM32Flash (const FlashSector *sectors, size_t sector_count, size_t start_sector)
	STM32Flash 类，构造时传入扇区列表，自动判断编程粒度。
	STM32Flash (const FlashSector *sectors, size_t sector_count)
	STM32Flash 类，自动取最后两个扇区
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. 获取闪存存储区域的大小。

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

Static Private Member Functions
static constexpr uint32_t	DetermineProgramType ()
static constexpr size_t	DetermineMinWriteSize ()

Private Attributes
const FlashSector *	sectors_
uint32_t	base_address_
uint32_t	program_type_
size_t	sector_count_

Detailed Description

STM32Flash 通用类，构造时传入扇区列表，自动判断编程粒度。

Definition at line 84 of file stm32_flash.hpp.

Constructor & Destructor Documentation

STM32Flash() [1/2]

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

STM32Flash 类，构造时传入扇区列表，自动判断编程粒度。

Parameters

sectors	扇区列表
sector_count	扇区数量
start_sector	起始扇区

Definition at line 5 of file stm32_flash.cpp.

    : Flash(sectors[start_sector - 1].size, DetermineMinWriteSize(),
            {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),
      program_type_(DetermineProgramType()),
      sector_count_(sector_count)
{
}

STM32Flash() [2/2]

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

inline

STM32Flash 类，自动取最后两个扇区

Parameters

sectors	扇区列表
sector_count	扇区数量

Definition at line 102 of file stm32_flash.hpp.

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

Member Function Documentation

DetermineMinWriteSize()

static constexpr size_t LibXR::STM32Flash::DetermineMinWriteSize ( )

inlinestaticconstexprprivate

Definition at line 134 of file stm32_flash.hpp.

  {
#ifdef FLASH_TYPEPROGRAM_BYTE
    return 1;
#elif defined(FLASH_TYPEPROGRAM_HALFWORD)
    return 2;
#elif defined(FLASH_TYPEPROGRAM_WORD)
    return 4;
#elif defined(FLASH_TYPEPROGRAM_DOUBLEWORD)
    return 8;
#elif defined(FLASH_TYPEPROGRAM_FLASHWORD)
    return FLASH_NB_32BITWORD_IN_FLASHWORD * 4;
#else
#error "No supported FLASH_TYPEPROGRAM_xxx defined"
#endif
  }

DetermineProgramType()

static constexpr uint32_t LibXR::STM32Flash::DetermineProgramType ( )

inlinestaticconstexprprivate

Definition at line 117 of file stm32_flash.hpp.

  {
#ifdef FLASH_TYPEPROGRAM_BYTE
    return FLASH_TYPEPROGRAM_BYTE;
#elif defined(FLASH_TYPEPROGRAM_HALFWORD)
    return FLASH_TYPEPROGRAM_HALFWORD;
#elif defined(FLASH_TYPEPROGRAM_WORD)
    return FLASH_TYPEPROGRAM_WORD;
#elif defined(FLASH_TYPEPROGRAM_DOUBLEWORD)
    return FLASH_TYPEPROGRAM_DOUBLEWORD;
#elif defined(FLASH_TYPEPROGRAM_FLASHWORD)
    return FLASH_TYPEPROGRAM_FLASHWORD;
#else
#error "No supported FLASH_TYPEPROGRAM_xxx defined"
#endif
  }

Erase()

ErrorCode STM32Flash::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 18 of file stm32_flash.cpp.

{
  if (size == 0)
  {
    return ErrorCode::ARG_ERR;
  }
 
  uint32_t start_addr = base_address_ + offset;
  uint32_t end_addr = start_addr + size;
 
  HAL_FLASH_Unlock();
 
  for (size_t i = 0; i < sector_count_; ++i)
  {
    const auto& sector = sectors_[i];
    if (sector.address + sector.size <= start_addr)
    {
      continue;
    }
    if (sector.address >= end_addr)
    {
      break;
    }
    FLASH_EraseInitTypeDef erase_init = {};
 
#if defined(FLASH_TYPEERASE_PAGES) && defined(FLASH_PAGE_SIZE)  // STM32F1/G4... series
    erase_init.TypeErase = FLASH_TYPEERASE_PAGES;
    SetNbPages(erase_init, sector.address, i);
    erase_init.NbPages = 1;
    SetBanks(erase_init);
#elif defined(FLASH_TYPEERASE_SECTORS)  // STM32F4/F7/H7... series
    erase_init.TypeErase = FLASH_TYPEERASE_SECTORS;
    erase_init.Sector = static_cast<uint32_t>(i);
    erase_init.NbSectors = 1;
    erase_init.Banks = FLASH_BANK_1;
#else
    return ErrorCode::NOT_SUPPORT;
#endif
 
    uint32_t error = 0;
    HAL_StatusTypeDef status = HAL_FLASHEx_Erase(&erase_init, &error);
    if (status != HAL_OK || error != 0xFFFFFFFFU)
    {
      HAL_FLASH_Lock();
      return ErrorCode::FAILED;
    }
  }
 
  HAL_FLASH_Lock();
  return ErrorCode::OK;
}

IsInRange()

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

private

Definition at line 144 of file stm32_flash.cpp.

{
  uint32_t end = addr + size;
  for (size_t i = 0; i < sector_count_; ++i)
  {
    const auto& s = sectors_[i];
    if (addr >= s.address && end <= s.address + s.size)
    {
      return true;
    }
  }
  return false;
}

Write()

ErrorCode STM32Flash::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 70 of file stm32_flash.cpp.

{
  if (!data.addr_ || data.size_ == 0)
  {
    return ErrorCode::ARG_ERR;
  }
 
  uint32_t addr = base_address_ + offset;
  if (!IsInRange(addr, data.size_))
  {
    return ErrorCode::OUT_OF_RANGE;
  }
 
  HAL_FLASH_Unlock();
 
  const uint8_t* src = reinterpret_cast<const uint8_t*>(data.addr_);
  size_t written = 0;
 
#if defined(STM32H7) || defined(STM32H5)
  alignas(32) uint32_t flash_word_buffer[8] = {0xFFFFFFFFu, 0xFFFFFFFFu, 0xFFFFFFFFu,
                                               0xFFFFFFFFu, 0xFFFFFFFFu, 0xFFFFFFFFu,
                                               0xFFFFFFFFu, 0xFFFFFFFFu};
  while (written < data.size_)
  {
    size_t chunk_size = LibXR::min<size_t>(MinWriteSize(), data.size_ - written);
 
    std::memcpy(flash_word_buffer, src + written, chunk_size);
 
    if (memcmp(reinterpret_cast<const uint8_t*>(addr + written), src + written,
               chunk_size) == 0)
    {
      written += chunk_size;
      continue;
    }
 
    if (HAL_FLASH_Program(program_type_, addr + written,
                          reinterpret_cast<uint32_t>(flash_word_buffer)) != HAL_OK)
    {
      HAL_FLASH_Lock();
      return ErrorCode::FAILED;
    }
 
    written += chunk_size;
  }
 
#else
  while (written < data.size_)
  {
    size_t chunk_size = LibXR::min<size_t>(MinWriteSize(), data.size_ - written);
 
    if (memcmp(reinterpret_cast<const uint8_t*>(addr + written), src + written,
               chunk_size) == 0)
    {
      written += chunk_size;
      continue;
    }
 
    uint64_t word = 0xFFFFFFFFFFFFFFFF;
    std::memcpy(&word, src + written, chunk_size);
 
    if (HAL_FLASH_Program(program_type_, addr + written, word) != HAL_OK)
    {
      HAL_FLASH_Lock();
      return ErrorCode::FAILED;
    }
 
    written += chunk_size;
  }
#endif
 
  HAL_FLASH_Lock();
  return ErrorCode::OK;
}

Field Documentation

base_address_

uint32_t LibXR::STM32Flash::base_address_

private

Definition at line 113 of file stm32_flash.hpp.

program_type_

uint32_t LibXR::STM32Flash::program_type_

private

Definition at line 114 of file stm32_flash.hpp.

sector_count_

size_t LibXR::STM32Flash::sector_count_

private

Definition at line 115 of file stm32_flash.hpp.

sectors_

const FlashSector* LibXR::STM32Flash::sectors_

private

Definition at line 112 of file stm32_flash.hpp.

---

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

• driver/st/stm32_flash.hpp
• driver/st/stm32_flash.cpp