ConOpSys V2970  P004.07
ANVILEX control operating system
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
TSPI_Memory_Base Class Referenceabstract

SPI memory base class. More...

#include <SPI_Memory_Base.h>

Inheritance diagram for TSPI_Memory_Base:
Inheritance graph
Collaboration diagram for TSPI_Memory_Base:
Collaboration graph

Classes

struct  TMemory_Chip_Descriptor
 Chip descriptior structure. More...
 

Public Member Functions

 TSPI_Memory_Base ()
 Base class constructor method. More...
 
virtual ~TSPI_Memory_Base ()
 Base class constructor method. More...
 
VOID Init ()
 SPI memory base object initialisation method. More...
 
VOID Done ()
 SPI memory base object finalisation method. More...
 
virtual VOID Start ()
 Start operation of SPI memory base driver. More...
 
virtual VOID Stop ()
 Stop operation of SPI memory base driver. More...
 
VOID Assign_SPI_Master (TSPI_Master_Base *object_New_SPI_Master)
 Assign SPI master hardware driver. More...
 
VOID Unassign_SPI_Master ()
 Unassign SPI master hardware driver. More...
 
virtual BOOL Read_Buffer (U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer)=0
 Read data from memory into the buffer method. More...
 
virtual BOOL Write_Buffer (U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer)=0
 Write data from buffer into memory method. More...
 
virtual BOOL Verify_Buffer (U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer)
 Verify data in memory and memory method. More...
 
virtual BOOL Erase_Chip (BOOL bool_Force_Bad_Block_Erase)
 Erase chip method. More...
 
BOOL Get_Block_Address (U16 u16_Block_Index, U32 *u32_Linear_Address)
 Get linear address of the block by specified block index. More...
 
BOOL Get_Page_Address (U16 u16_Block_Index, U16 u16_Relative_Page_Index, U32 *u32_Linear_Address)
 Get linear address of the page by specified block index and relative page index. More...
 
U32 Get_Capacity ()
 Get capacity of attached SPI memory. More...
 
TRIL Is_Available ()
 Return SPI avaliability. More...
 
virtual VOID Send_Information (TProtocol_Base *object_Protocol)
 Method sends default driver information over specified communication channel. More...
 
BOOL Get_Page_Index (U32 u32_Linear_Address, U32 *u32_Page_Index)
 Get page index from lenear address. More...
 
BOOL Get_Page_Index (U16 u16_Block_Index, U16 u16_Page_Relative_Index, U32 *u32_Page_Index)
 Get page index from block index and page relative index. More...
 
BOOL Get_Block_Index_By_Page (U32 u32_Page_Index, U16 *u16_Block_Index)
 Get block index by page index. More...
 
BOOL Get_Page_Index (U16 u16_Block_Index, U32 *u32_Page_Index)
 Get page index of the block. More...
 
BOOL Get_Page_Size (U16 *u16_Page_Size)
 Return page size in bytes. More...
 
BOOL Get_Pages_Per_Block_Count (U16 *u16_Pages_Per_Block)
 Return pages number into block. More...
 
BOOL Get_Block_Count (U16 *u16_Block_Count)
 Return total amount of the blocks. More...
 
BOOL Get_Pages_Per_Chip_Count (U32 *u32_Pages_Per_Chip)
 Return total amount of the pages. More...
 

Protected Member Functions

BOOL Get_Chip_Size (U32 *u32_Chip_Size)
 Return total chip capacity in bytes. More...
 
BOOL Get_Block_Size (U32 *u32_Block_Size)
 Return block size in bytes. More...
 
BOOL Extract_Page_Relative_Address (U32 u32_Linear_Address, U16 *u16_Relative_Address)
 Extract page relative address from lenear address. More...
 
BOOL Is_Block_Index_In_Range (U16 u16_Block_Index)
 This method check that block index is valid. More...
 
BOOL Is_Page_Index_In_Range (U32 u32_Page_Index)
 This method check that page index is valid. More...
 

Protected Attributes

TSPI_Master_Baseobject_SPI_Master = (TSPI_Master_Base*)NULL
 Pointer to the SPI master object. More...
 
TMemory_Chip_Descriptorstruct_Memory_Chip_Descriptor = (TMemory_Chip_Descriptor*)NULL
 Pointer to the chip descriptor structure. More...
 
TRIL tril_Available = (TRIL)unset
 Memory chip availablility status. More...
 
BOOL bool_Manufacturer_ID_Available = (BOOL)false
 Manufacturer ID availablility status. More...
 
BOOL bool_Device_ID_Available = (BOOL)false
 Device ID availablility status. More...
 
BOOL bool_Serial_Number_Available = (BOOL)false
 Serial number availablility status. More...
 
U32 u32_Capacity = (U32)0
 Depricated: Capacity of SPI memory in bytes. More...
 

Private Member Functions

virtual BOOL Write_Enable ()
 Enable write operation into memory. More...
 
virtual BOOL Write_Disable ()
 Disable write operation into memory. More...
 
virtual BOOL Read_Status_Register (U8 *u8_StatusRegister)
 Read memory device status register method. More...
 
virtual BOOL Write_Status_Register (U8 u8_StatusRegister)
 Write memory device status register method. More...
 
virtual BOOL Read_Memory (U32 u32_Address, U8 *u8_Data)
 Read byte from memory. More...
 
virtual BOOL Write_Memory (U32 u32_Address, U8 u8_Data)
 Write byte into memory. More...
 
virtual BOOL Read_Identification ()=0
 Read memory device identification information pure virtual method. More...
 
BOOL Is_Page_Relative_Index_In_Range (U16 u16_Page_Relative_Index)
 This method check that relative index is valid. More...
 

Detailed Description

SPI memory base class.

Constructor & Destructor Documentation

◆ TSPI_Memory_Base()

TSPI_Memory_Base::TSPI_Memory_Base ( )

Base class constructor method.


Note
None
Override
Not allowed
Attention
Don't call this method directly.

◆ ~TSPI_Memory_Base()

TSPI_Memory_Base::~TSPI_Memory_Base ( )
virtual

Base class constructor method.


Note
None
Override
Not allowed
Attention
Don't call this method directly.

Member Function Documentation

◆ Assign_SPI_Master()

VOID TSPI_Memory_Base::Assign_SPI_Master ( TSPI_Master_Base object_New_SPI_Master)

Assign SPI master hardware driver.


Note
None
Parameters
[in]*object_New_SPI_Master- Pointer to the SPI master hardware driver
Returns
None
Override
Not requered
Attention
None

References object_SPI_Master.

Referenced by TApplication_Base::Init(), and TBootloader_Base::Init().

Here is the caller graph for this function:

◆ Done()

VOID TSPI_Memory_Base::Done ( )

SPI memory base object finalisation method.


Note
None
Returns
None
Override
Optional
Attention
None

◆ Erase_Chip()

BOOL TSPI_Memory_Base::Erase_Chip ( BOOL  bool_Force_Bad_Block_Erase)
virtual

Erase chip method.


Note
This method can done full erase the memory, or erase only not damage blocks
Parameters
[in]bool_Force_Bad_Block_Erase- Option to select an erase type
Returns
BOOL - Erasing status
Return values
false- Erase falled
true- Erase successfully done
Override
Optional
Attention
None

Reimplemented in TS25FL512.

◆ Extract_Page_Relative_Address()

BOOL TSPI_Memory_Base::Extract_Page_Relative_Address ( U32  u32_Linear_Address,
U16 u16_Relative_Address 
)
protected

Extract page relative address from lenear address.


Note
None
Parameters
[in]u32_Linear_Address- Linear address
[out]*u16_Relative_Address- Relative address from beggining of the page
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Page_Size(), and Get_Pages_Per_Block_Count().

Referenced by TS25FL512::Read_Extended_Buffer(), TS25FL512::Read_Page_From_Cache_By_Leniar_Address(), and TS25FL512::Write_Page_To_Cache_By_Leniar_Address().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get_Block_Address()

BOOL TSPI_Memory_Base::Get_Block_Address ( U16  u16_Block_Index,
U32 u32_Linear_Address 
)

Get linear address of the block by specified block index.


Note
None
Parameters
[in]u16_Block_Index- Block index
[out]*u32_Linear_Address- Linear address of the block
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Block_Count(), and Get_Block_Size().

Here is the call graph for this function:

◆ Get_Block_Count()

BOOL TSPI_Memory_Base::Get_Block_Count ( U16 u16_Block_Count)

Return total amount of the blocks.


Note
None
Parameters
[out]*u16_Block_Count- Total block count
Returns
BOOL - Operation status
Return values
false- Operation failed, total block count can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u16_Blocks_Per_Chip_Count.

Referenced by TS25FL512::Erase_Chip(), TEvent_Manager::Execute(), Get_Block_Address(), TEvent_Manager::Get_Min_Max_Flash_Index(), Get_Page_Index(), Is_Block_Index_In_Range(), TS25FL512::QA_Erase_Block_Test(), and TS25FL512::QA_Single_Block_Erase_Test().

Here is the caller graph for this function:

◆ Get_Block_Index_By_Page()

BOOL TSPI_Memory_Base::Get_Block_Index_By_Page ( U32  u32_Page_Index,
U16 u16_Block_Index 
)

Get block index by page index.


Note
None
Parameters
[in]u32_Page_Index- Page number of the chip
[out]*u16_Block_Index- Block index
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Pages_Per_Block_Count(), and Get_Pages_Per_Chip_Count().

Referenced by TEvent_Manager::Half_Devision_Method_Searching(), TS25FL512::QA_Read_Page_Test(), and TS25FL512::QA_Write_Page_Test().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get_Block_Size()

BOOL TSPI_Memory_Base::Get_Block_Size ( U32 u32_Block_Size)
protected

Return block size in bytes.


Note
None
Parameters
[out]*u32_Block_Size- Block size in bytes
Returns
BOOL - Operation status
Return values
false- Operation failed, block size can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u32_Block_Size.

Referenced by Get_Block_Address(), and Get_Page_Address().

Here is the caller graph for this function:

◆ Get_Capacity()

U32 TSPI_Memory_Base::Get_Capacity ( )

Get capacity of attached SPI memory.


Note
None
Returns
U32 - Capacity of attached SPI memory
Override
Not requered
Attention
None DEPRICATED: Get capacity of attached SPI memory

References u32_Capacity.

Referenced by TParameter_Manager::Assign_Media(), and TParameter_Manager::Show_Boot_Information().

Here is the caller graph for this function:

◆ Get_Chip_Size()

BOOL TSPI_Memory_Base::Get_Chip_Size ( U32 u32_Chip_Size)
protected

Return total chip capacity in bytes.


Note
None
Parameters
[out]*u32_Chip_Size- Total chip size in bytes
Returns
BOOL - Operation status
Return values
false- Operation failed, total chip size can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u32_Chip_Size.

Referenced by TS25FL512::Write_Buffer().

Here is the caller graph for this function:

◆ Get_Page_Address()

BOOL TSPI_Memory_Base::Get_Page_Address ( U16  u16_Block_Index,
U16  u16_Relative_Page_Index,
U32 u32_Linear_Address 
)

Get linear address of the page by specified block index and relative page index.


Note
None
Parameters
[in]u16_Block_Index- Block index
[in]u16_Relative_Page_Index- Page relative index within block
[out]*u32_Linear_Address- Linear address of the block
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Block_Size(), and Get_Page_Size().

Referenced by TEvent_Manager::Execute(), and TS25FL512::Get_Bad_Block_Status().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get_Page_Index() [1/3]

BOOL TSPI_Memory_Base::Get_Page_Index ( U16  u16_Block_Index,
U16  u16_Page_Relative_Index,
U32 u32_Page_Index 
)

Get page index from block index and page relative index.


Note
None
Parameters
[in]u16_Block_Index- Block index
[in]u16_Page_Relative_Index- Page relative index
[out]*u32_Page_Index- Page index
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

◆ Get_Page_Index() [2/3]

BOOL TSPI_Memory_Base::Get_Page_Index ( U16  u16_Block_Index,
U32 u32_Page_Index 
)

Get page index of the block.


Note
None
Parameters
[in]u16_Block_Index- Block index
[out]*u32_Page_Index- Page number of the chip
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Block_Count(), and Get_Pages_Per_Block_Count().

Here is the call graph for this function:

◆ Get_Page_Index() [3/3]

BOOL TSPI_Memory_Base::Get_Page_Index ( U32  u32_Linear_Address,
U32 u32_Page_Index 
)

Get page index from lenear address.


Note
None
Parameters
[in]u32_Linear_Address- Linear address
[out]*u32_Page_Index- Page index
Returns
BOOL - Operation status
Return values
false- Operation failed
true- Operation succeeded
Override
Not requered
Attention
None

References Get_Page_Size().

Referenced by TEvent_Manager::Get_Min_Max_Flash_Index(), and TS25FL512::Is_Block_Empty().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get_Page_Size()

BOOL TSPI_Memory_Base::Get_Page_Size ( U16 u16_Page_Size)

Return page size in bytes.


Note
None
Parameters
[out]*u16_Page_Size- Page size in bytes
Returns
BOOL - Operation status
Return values
false- Operation failed, page size can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u16_Page_Size.

Referenced by TEvent_Manager::Execute(), Extract_Page_Relative_Address(), TEvent_Manager::Get_Min_Max_Flash_Index(), Get_Page_Address(), Get_Page_Index(), TS25FL512::Is_Page_In_Cache_Empty(), TS25FL512::QA_Read_Page_Test(), TS25FL512::QA_Write_Page_Test(), and TS25FL512::Write_Buffer_By_Page_Index().

Here is the caller graph for this function:

◆ Get_Pages_Per_Block_Count()

BOOL TSPI_Memory_Base::Get_Pages_Per_Block_Count ( U16 u16_Pages_Per_Block)

Return pages number into block.


Note
None
Parameters
[out]*u16_Pages_Per_Block- Page into block
Returns
BOOL - Operation status
Return values
false- Operation failed, block size can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u16_Pages_Per_Block_Count.

Referenced by TS25FL512::Erase_Block_By_Index(), TEvent_Manager::Execute(), Extract_Page_Relative_Address(), Get_Block_Index_By_Page(), TEvent_Manager::Get_Min_Max_Flash_Index(), Get_Page_Index(), TS25FL512::Is_Block_Empty(), Is_Page_Relative_Index_In_Range(), TS25FL512::QA_Read_Page_Test(), and TS25FL512::QA_Write_Page_Test().

Here is the caller graph for this function:

◆ Get_Pages_Per_Chip_Count()

BOOL TSPI_Memory_Base::Get_Pages_Per_Chip_Count ( U32 u32_Pages_Per_Chip)

Return total amount of the pages.


Note
None
Parameters
[out]*u32_Pages_Per_Chip- Total pages count
Returns
BOOL - Operation status
Return values
false- Operation failed, total block count can not be retrieved
true- Operation succeeded
Override
Not requered
Attention
None

References NULL, struct_Memory_Chip_Descriptor, and TSPI_Memory_Base::TMemory_Chip_Descriptor::u32_Pages_Per_Chip_Count.

Referenced by TEvent_Manager::Execute(), Get_Block_Index_By_Page(), Is_Page_Index_In_Range(), TS25FL512::QA_Read_Page_Test(), TS25FL512::QA_Write_Page_Test(), and TS25FL512::Write_Buffer_By_Page_Index().

Here is the caller graph for this function:

◆ Init()

VOID TSPI_Memory_Base::Init ( )

SPI memory base object initialisation method.


Note
None
Returns
None
Override
Optional
Attention
None

References bool_Serial_Number_Available, NULL, object_SPI_Master, tril_Available, u32_Capacity, and unset.

Referenced by TFM25V02::Init(), and TS25FL512::Init().

Here is the caller graph for this function:

◆ Is_Available()

TRIL TSPI_Memory_Base::Is_Available ( )

Return SPI avaliability.


Note
None
Returns
TRIL - SPI avaliability
Override
Not requered
Attention
DEPRICATED: Return SPI avaliability

References tril_Available.

Referenced by TParameter_Manager::Assign_Media(), TCommand_INFO::Execute(), TCommand_NVRAM_STATUS::Execute(), and TParameter_Manager::Is_Media_Database_Available().

Here is the caller graph for this function:

◆ Is_Block_Index_In_Range()

BOOL TSPI_Memory_Base::Is_Block_Index_In_Range ( U16  u16_Block_Index)
protected

This method check that block index is valid.


Note
None
Parameters
[in]u16_Block_Index- Block index
Returns
BOOL - Operation status
Return values
false- Verification succeeded
true- Operation failed, verification failed
Override
Requered
Attention
None

References Get_Block_Count().

Referenced by TS25FL512::QA_Erase_Block_Test(), and TS25FL512::QA_Single_Block_Erase_Test().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Is_Page_Index_In_Range()

BOOL TSPI_Memory_Base::Is_Page_Index_In_Range ( U32  u32_Page_Index)
protected

This method check that page index is valid.


Note
None
Parameters
[in]u32_Page_Index- Page index
Returns
BOOL - Operation status
Return values
false- Verification succeeded
true- Operation failed, verification failed
Override
Requered
Attention
None

References Get_Pages_Per_Chip_Count().

Referenced by TS25FL512::QA_Read_Page_Test(), and TS25FL512::QA_Write_Page_Test().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Is_Page_Relative_Index_In_Range()

BOOL TSPI_Memory_Base::Is_Page_Relative_Index_In_Range ( U16  u16_Page_Relative_Index)
private

This method check that relative index is valid.


Note
None
Parameters
[in]u16_Page_Relative_Index- Relative index
Returns
BOOL - Operation status
Return values
false- Verification succeeded
true- Operation failed, verification failed
Override
Requered
Attention
None

References Get_Pages_Per_Block_Count().

Here is the call graph for this function:

◆ Read_Buffer()

virtual BOOL TSPI_Memory_Base::Read_Buffer ( U32  u32_Linear_Address,
U32  u32_Size,
U8 u8_Data_Buffer 
)
pure virtual

Read data from memory into the buffer method.


Note
None
Parameters
[in]u32_Linear_Address- Linear address in memory
[in]u32_Size- Amount byte to read
[out]*u8_Data_Buffer- Pointer to the data buffer
Returns
BOOL - Read operation status
Return values
false- Read operation failed
true- Read operation succeeded
Override
Requered
Attention
None

Implemented in TS25FL512, and TFM25V02.

Referenced by TParameter_Manager::Allocate_Parameter_Media_Storege_Index(), TParameter_Manager::Media_Database_Read_Record(), and TParameter_Manager::Update_Empty_Block_Address().

Here is the caller graph for this function:

◆ Read_Identification()

virtual BOOL TSPI_Memory_Base::Read_Identification ( )
privatepure virtual

Read memory device identification information pure virtual method.


Note
None
Returns
None
Override
Requered
Attention
None

Implemented in TS25FL512, and TFM25V02.

◆ Read_Memory()

BOOL TSPI_Memory_Base::Read_Memory ( U32  u32_Address,
U8 u8_Data 
)
privatevirtual

Read byte from memory.


Note
None
Parameters
[in]u32_Address- Linear address
[out]*u8_Data- Pointer to byte value
Returns
BOOL - Read operation status
Return values
false- Read operation succeeded
true- Read operation failed
Override
Requered
Attention
None

Reimplemented in TFM25V02.

◆ Read_Status_Register()

BOOL TSPI_Memory_Base::Read_Status_Register ( U8 u8_StatusRegister)
privatevirtual

Read memory device status register method.


Note
None
Parameters
[out]*u8_StatusRegister- Pointer to status register value
Returns
BOOL - Read operation status
Return values
false- Read operation succeeded
true- Read operation failed
Override
Requered
Attention
None

Reimplemented in TS25FL512, and TFM25V02.

◆ Send_Information()

VOID TSPI_Memory_Base::Send_Information ( TProtocol_Base object_Protocol)
virtual

Method sends default driver information over specified communication channel.


Note
None
Parameters
[in]*object_Protocol- Pointer to the connunication channel
Returns
None
Override
Not requered
Attention
None

Reimplemented in TS25FL512.

◆ Start()

VOID TSPI_Memory_Base::Start ( )
virtual

Start operation of SPI memory base driver.


Note
This method start operation of memory driver and underlayed SPI hardware driver.
Returns
None
Override
Optional
Attention
None

Reimplemented in TS25FL512, and TFM25V02.

References NULL, object_SPI_Master, and TSPI_Master_Base::Start().

Referenced by TS25FL512::Start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Stop()

VOID TSPI_Memory_Base::Stop ( )
virtual

Stop operation of SPI memory base driver.


Note
This method stop operation of memory driver and underlayed SPI hardware driver.
Returns
None
Override
Optional
Attention
None

References NULL, object_SPI_Master, and TSPI_Master_Base::Stop().

Here is the call graph for this function:

◆ Unassign_SPI_Master()

VOID TSPI_Memory_Base::Unassign_SPI_Master ( )

Unassign SPI master hardware driver.


Note
None
Returns
None
Override
Not requered
Attention
None

References NULL, and object_SPI_Master.

◆ Verify_Buffer()

BOOL TSPI_Memory_Base::Verify_Buffer ( U32  u32_Linear_Address,
U32  u32_Size,
U8 u8_Data_Buffer 
)
virtual

Verify data in memory and memory method.


Note
None
Parameters
[in]u32_Linear_Address- Linear address in memory
[in]u32_Size- Amount byte to verify
[in]*u8_Data_Buffer- Pointer to the data buffer
Returns
BOOL - Verification operation status
Return values
false- Verification operation failed, data in buffer and memory not equal
true- Verification operation succeeded, data in buffer and memory equal
Override
Optional
Attention
None

Reimplemented in TFM25V02.

◆ Write_Buffer()

virtual BOOL TSPI_Memory_Base::Write_Buffer ( U32  u32_Linear_Address,
U32  u32_Size,
U8 u8_Data_Buffer 
)
pure virtual

Write data from buffer into memory method.


Note
None
Parameters
[in]u32_Linear_Address- Linear address in memory
[in]u32_Size- Amount byte to write
[in]*u8_Data_Buffer- Pointer to the data buffer
Returns
BOOL - Write operation status
Return values
false- Write operation failed
true- Write operation succeeded
Override
Optional
Attention
None

Implemented in TS25FL512, and TFM25V02.

Referenced by TParameter_Manager::Media_Database_Invalidate_Record(), and TParameter_Manager::Media_Database_Write_Record().

Here is the caller graph for this function:

◆ Write_Disable()

BOOL TSPI_Memory_Base::Write_Disable ( )
privatevirtual

Disable write operation into memory.


Note
None
Returns
BOOL - Operation status
Return values
false- Operation succeeded
true- Operation failed
Override
Optional
Attention
Override this method if memory support enabling and disabling write protection function.

Reimplemented in TS25FL512.

◆ Write_Enable()

BOOL TSPI_Memory_Base::Write_Enable ( )
privatevirtual

Enable write operation into memory.


Note
None
Returns
BOOL - Operation status
Return values
false- Operation succeeded
true- Operation failed
Override
Optional
Attention
Override this method if memory support enabling and disabling write protection function.

Reimplemented in TS25FL512.

◆ Write_Memory()

BOOL TSPI_Memory_Base::Write_Memory ( U32  u32_Address,
U8  u8_Data 
)
privatevirtual

Write byte into memory.


Note
None
Parameters
[in]u32_Address- Linear address
[in]u8_Data- Data byte value to write
Returns
BOOL - Write operation status
Return values
false- Write operation succeeded
true- Write operation failed
Override
Requered
Attention
None

Reimplemented in TFM25V02.

◆ Write_Status_Register()

BOOL TSPI_Memory_Base::Write_Status_Register ( U8  u8_StatusRegister)
privatevirtual

Write memory device status register method.


Note
None
Parameters
[in]u8_StatusRegister- Status register value to write
Returns
BOOL - Write operation status
Return values
false- Write operation succeeded
true- Write operation failed
Override
Requered
Attention
None

Reimplemented in TFM25V02.

Member Data Documentation

◆ bool_Device_ID_Available

BOOL TSPI_Memory_Base::bool_Device_ID_Available = (BOOL)false
protected

Device ID availablility status.

Referenced by TFM25V02::Read_Device_ID(), and TS25FL512::Read_Identification().

◆ bool_Manufacturer_ID_Available

BOOL TSPI_Memory_Base::bool_Manufacturer_ID_Available = (BOOL)false
protected

Manufacturer ID availablility status.

Referenced by TS25FL512::Read_Identification().

◆ bool_Serial_Number_Available

BOOL TSPI_Memory_Base::bool_Serial_Number_Available = (BOOL)false
protected

Serial number availablility status.

Referenced by Init(), and TFM25V02::Read_Serial_Number().

◆ object_SPI_Master

TSPI_Master_Base* TSPI_Memory_Base::object_SPI_Master = (TSPI_Master_Base*)NULL
protected

◆ struct_Memory_Chip_Descriptor

TMemory_Chip_Descriptor* TSPI_Memory_Base::struct_Memory_Chip_Descriptor = (TMemory_Chip_Descriptor*)NULL
protected

◆ tril_Available

TRIL TSPI_Memory_Base::tril_Available = (TRIL)unset
protected

Memory chip availablility status.

Referenced by Init(), Is_Available(), TS25FL512::Read_Identification(), and TFM25V02::Start().

◆ u32_Capacity

U32 TSPI_Memory_Base::u32_Capacity = (U32)0
protected

Depricated: Capacity of SPI memory in bytes.

Referenced by Get_Capacity(), Init(), and TFM25V02::Start().


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