LibXR::LinuxBinaryFileFlash< FLASH_SIZE > Class Template Reference

Linux 二进制文件闪存实现 / Linux binary-file flash implementation. More...

#include <linux_flash.hpp>

Inheritance diagram for LibXR::LinuxBinaryFileFlash< FLASH_SIZE >:

Collaboration diagram for LibXR::LinuxBinaryFileFlash< FLASH_SIZE >:

Public Member Functions
	LinuxBinaryFileFlash (const std::string &file_path, size_t min_erase_size=FLASH_SIZE/2, size_t min_write_size=sizeof(uint8_t), bool write_order_check=false, bool write_as_one_check=false)
	构造 Linux 文件闪存对象 / Construct Linux file-backed flash
ErrorCode	Erase (size_t offset, size_t size) override
	擦除闪存区域 / Erase flash area
ErrorCode	Write (size_t offset, ConstRawData data) override
	写入闪存数据 / Write flash data
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
ErrorCode	SyncToFile ()

Private Attributes
std::string	file_path_
std::array< uint8_t, FLASH_SIZE >	flash_area_ = {}
bool	write_order_check_
bool	write_as_one_check_

Detailed Description

template<size_t FLASH_SIZE>
class LibXR::LinuxBinaryFileFlash< FLASH_SIZE >

Linux 二进制文件闪存实现 / Linux binary-file flash implementation.

Template Parameters

FLASH_SIZE

闪存容量（字节） / Flash size in bytes

Definition at line 22 of file linux_flash.hpp.

Constructor & Destructor Documentation

LinuxBinaryFileFlash()

template<size_t FLASH_SIZE>

LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::LinuxBinaryFileFlash ( const std::string & file_path, size_t min_erase_size = FLASH_SIZE / 2, size_t min_write_size = sizeof(uint8_t), bool write_order_check = false, bool write_as_one_check = false )

inline

构造 Linux 文件闪存对象 / Construct Linux file-backed flash

Parameters

file_path	二进制文件路径 / Binary file path
min_erase_size	最小擦除块大小 / Minimum erase block size
min_write_size	最小写入块大小 / Minimum write block size
write_order_check	写入顺序检查开关 / Enable write order check
write_as_one_check	写入一致性检查开关 / Enable write consistency check

Definition at line 34 of file linux_flash.hpp.

      : Flash(min_erase_size, min_write_size, RawData(&flash_area_, sizeof(flash_area_))),
        file_path_(file_path),
        write_order_check_(write_order_check),
        write_as_one_check_(write_as_one_check)
  {
    std::ifstream file(file_path_, std::ios::binary);
    if (file)
    {
      file.read(reinterpret_cast<char*>(flash_area_.data()),
                static_cast<std::streamsize>(flash_area_.size()));
    }
  }

Member Function Documentation

Erase()

template<size_t FLASH_SIZE>

ErrorCode LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::Erase ( size_t offset, size_t size )

inlineoverridevirtual

擦除闪存区域 / Erase flash area

Parameters

offset	相对闪存起始地址的偏移 / Offset from flash base
size	擦除长度 / Erase size

Returns

ErrorCode 错误码 / Error code

Implements LibXR::Flash.

Definition at line 58 of file linux_flash.hpp.

  {
    ASSERT(offset % MinEraseSize() == 0);
    ASSERT(size % MinEraseSize() == 0);
 
    if ((offset + size) > flash_area_.size())
    {
      return ErrorCode::OUT_OF_RANGE;
    }
 
    Memory::FastSet(flash_area_.data() + offset, 0xFF, size);
 
    return SyncToFile();
  }

SyncToFile()

template<size_t FLASH_SIZE>

ErrorCode LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::SyncToFile ( )

inlineprivate

Definition at line 123 of file linux_flash.hpp.

  {
    std::ofstream file(file_path_, std::ios::binary | std::ios::trunc);
    if (!file)
    {
      return ErrorCode::FAILED;
    }
    file.write(reinterpret_cast<const char*>(flash_area_.data()),
               static_cast<std::streamsize>(flash_area_.size()));
    return ErrorCode::OK;
  }

Write()

template<size_t FLASH_SIZE>

ErrorCode LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::Write ( size_t offset, ConstRawData data )

inlineoverridevirtual

写入闪存数据 / Write flash data

Parameters

offset	相对闪存起始地址的偏移 / Offset from flash base
data	写入数据 / Data to write

Returns

ErrorCode 错误码 / Error code

Implements LibXR::Flash.

Definition at line 80 of file linux_flash.hpp.

  {
    if ((offset + data.size_) > flash_area_.size())
    {
      return ErrorCode::OUT_OF_RANGE;
    }
 
    if (offset % MinWriteSize() != 0 || data.size_ % MinWriteSize() != 0)
    {
      ASSERT(false);
      return ErrorCode::FAILED;
    }
 
    if (write_order_check_)
    {
      ASSERT(offset % MinEraseSize() == 0);
    }
 
    uint8_t* dst = flash_area_.data() + offset;
    const uint8_t* src = static_cast<const uint8_t*>(data.addr_);
 
    if (write_as_one_check_)
    {
      for (size_t i = 0; i < data.size_; ++i)
      {
        if ((~dst[i] & src[i]))
        {
          ASSERT(false);
          return ErrorCode::FAILED;
        }
      }
    }
 
    Memory::FastCopy(dst, src, data.size_);
    return SyncToFile();
  }

Field Documentation

file_path_

template<size_t FLASH_SIZE>

std::string LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::file_path_

private

Definition at line 118 of file linux_flash.hpp.

flash_area_

template<size_t FLASH_SIZE>

std::array<uint8_t, FLASH_SIZE> LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::flash_area_ = {}

private

Definition at line 119 of file linux_flash.hpp.

{};

write_as_one_check_

template<size_t FLASH_SIZE>

bool LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::write_as_one_check_

private

Definition at line 121 of file linux_flash.hpp.

write_order_check_

template<size_t FLASH_SIZE>

bool LibXR::LinuxBinaryFileFlash< FLASH_SIZE >::write_order_check_

private

Definition at line 120 of file linux_flash.hpp.

---

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

• driver/linux/linux_flash.hpp