Abstract base class representing a flash memory interface. 抽象基类，表示闪存接口。 More...

#include <flash.hpp>

Inheritance diagram for LibXR::Flash:

Collaboration diagram for LibXR::Flash:

Public Member Functions
	Flash (size_t min_erase_size, size_t min_write_size, RawData flash_area)
	Constructs a Flash object with specified properties. 构造函数，初始化闪存属性。

virtual ErrorCode	Erase (size_t offset, size_t size)=0
	Erases a section of the flash memory. 擦除闪存的指定区域。

virtual ErrorCode	Write (size_t offset, ConstRawData data)=0
	Writes data to the flash memory. 向闪存写入数据。

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 Attributes
size_t	min_erase_size_
	Minimum erasable block size in bytes. 最小可擦除块大小（字节）。

size_t	min_write_size_
	Minimum writable block size in bytes. 最小可写块大小（字节）。

RawData	flash_area_

Detailed Description

Abstract base class representing a flash memory interface. 抽象基类，表示闪存接口。

Definition at line 18 of file flash.hpp.

Constructor & Destructor Documentation

◆ Flash()

Flash::Flash	(	size_t	min_erase_size,
		size_t	min_write_size,
		RawData	flash_area )

Constructs a Flash object with specified properties. 构造函数，初始化闪存属性。

Parameters

min_erase_size	Minimum erasable block size in bytes. 最小可擦除块大小（字节）。
min_write_size	Minimum writable block size in bytes. 最小可写块大小（字节）。
flash_area	Memory area allocated for flash operations. 用于闪存操作的存储区域。

Definition at line 7 of file flash.cpp.

    : min_erase_size_(min_erase_size),
      min_write_size_(min_write_size),
      flash_area_(flash_area)
{
}

Member Function Documentation

◆ Erase()

virtual ErrorCode LibXR::Flash::Erase	(	size_t	offset,
		size_t	size )

pure virtual

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. 返回操作结果的错误码。

Implemented in LibXR::CH32Flash, LibXR::LinuxBinaryFileFlash< FLASH_SIZE >, and LibXR::STM32Flash.

◆ MinEraseSize()

size_t LibXR::Flash::MinEraseSize ( ) const

inline

Returns the minimum erasable block size in bytes. 获取最小可擦除块大小（字节）。

Returns: size_t Minimum erasable block size in bytes. 最小可擦除块大小（字节）。

Definition at line 64 of file flash.hpp.

64{ return min_erase_size_; }

◆ MinWriteSize()

size_t LibXR::Flash::MinWriteSize ( ) const

inline

Returns the minimum writable block size in bytes. 获取最小可写块大小（字节）。

Returns: size_t Minimum writable block size in bytes. 最小可写块大小（字节）。

Definition at line 73 of file flash.hpp.

73{ return min_write_size_; }

◆ Read()

ErrorCode Flash::Read	(	size_t	offset,
		RawData	data )

virtual

Reads data from the flash memory. 从闪存中读取数据。

Parameters

offset	The starting offset to read data. 数据读取的起始偏移地址。
data	Data buffer to store the read data. 存储读取数据的缓冲区。

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

Definition at line 14 of file flash.cpp.

{
  ASSERT(offset + data.size_ <= flash_area_.size_);
  LibXR::Memory::FastCopy(data.addr_,
                          reinterpret_cast<const uint8_t*>(flash_area_.addr_) + offset,
                          data.size_);
 
  return ErrorCode::OK;
}

◆ Size()

size_t LibXR::Flash::Size ( ) const

inline

Returns the size of the flash memory area. 获取闪存存储区域的大小。

Returns: size_t Size of the flash memory area. 闪存存储区域的大小。

Definition at line 82 of file flash.hpp.

82{ return flash_area_.size_; }

◆ Write()

virtual ErrorCode LibXR::Flash::Write	(	size_t	offset,
		ConstRawData	data )

pure virtual

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. 返回操作结果的错误码。

Implemented in LibXR::CH32Flash, LibXR::LinuxBinaryFileFlash< FLASH_SIZE >, and LibXR::STM32Flash.

Field Documentation

◆ flash_area_

RawData LibXR::Flash::flash_area_

private

Memory area allocated for flash operations. 用于闪存操作的存储区域。

Definition at line 89 of file flash.hpp.

◆ min_erase_size_

size_t LibXR::Flash::min_erase_size_

private

Initial value:

=

0

Minimum erasable block size in bytes. 最小可擦除块大小（字节）。

Definition at line 85 of file flash.hpp.

◆ min_write_size_

size_t LibXR::Flash::min_write_size_

private

Initial value:

=

0

Minimum writable block size in bytes. 最小可写块大小（字节）。

Definition at line 87 of file flash.hpp.

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

src/driver/flash.hpp
src/driver/flash.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Flash()

Member Function Documentation

◆ Erase()

◆ MinEraseSize()

◆ MinWriteSize()

◆ Read()

◆ Size()

◆ Write()

Field Documentation

◆ flash_area_

◆ min_erase_size_

◆ min_write_size_