S25FL512.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       S25FL512.h
//! @brief      SPI NAND FLASH memory chip S25FL512 hardware driver class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Peripherals/SPI_Memory/S25FL512.h $
//!             $Revision: 2765 $
//!             $Date: 2021-07-04 04:32:25 +0500 (So, 04 Jul 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include project files
//------------------------------------------------------------------------------
 
#include "SPI_Memory_Base.h"
 
//------------------------------------------------------------------------------
// Defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class
//------------------------------------------------------------------------------
 
//! @brief NAND memory hardware driver
class TS25FL512 : public TSPI_Memory_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Constructor and destructor methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
//    TS25FL512();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
//    virtual ~TS25FL512();
 
    //!-------------------------------------------------------------------------
    //! @brief     Driver initialisation method.
    //! @note      By calling this method driver make internal initialisation and prepering for operation.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Driver start operation method.
    //! @note      By calling this method driver starts opration.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start();
 
    //!-------------------------------------------------------------------------
    //! @brief     Background execute method.
    //! @note      None.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read data from memory into buffer.
    //! @note      None
    //! @param     [in] u32_Linear_Address - Linear address of the data in memory
    //! @param     [in] u32_Size - Size of the data to read
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Data read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Buffer( U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read data from memory into buffer.
    //! @note      None
    //! @param     [in] u32_Linear_Address - Linear address of the data in memory
    //! @param     [in] u32_Size - Size of the data to read
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Data read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Extended_Buffer( U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read data from memory into buffer.
    //! @note      None
    //! @param     [in] u32_Page_Index - Page index
    //! @param     [in] u16_Offset - Offset inside page
    //! @param     [in] u32_Size - Size of the data to read
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Data read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Buffer_By_Page_Index( U32 u32_Page_Index, U16 u16_Offset, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write data from buffer into memory.
    //! @note      None
    //! @param     [in] u32_Linear_Address - Linear address of the data in memory
    //! @param     [in] u32_Size - Size of the data to write
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Data write operation status
    //! @retval    false - Write operation failed
    //! @retval    true - Write operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Write_Buffer( U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write data from buffer into memory.
    //! @note      None
    //! @param     [in] u32_Page_Index - Page index
    //! @param     [in] u16_Offset - Offset into page
    //! @param     [in] u32_Size - Size of the data to write
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Data write operation status
    //! @retval    false - Write operation failed
    //! @retval    true - Write operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Write_Buffer_By_Page_Index( U32 u32_Page_Index, U16 u16_Offset, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Erase block referenced by block index.
    //! @note      None
    //! @param     [in] u16_Block_Index - Block index to erase
    //! @return    BOOL - Erase operation status
    //! @retval    false - Erase operation failed
    //! @retval    true - Erase operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Erase_Block_By_Index( U16 u16_Block_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Erase all blocks of the chip.
    //! @note      None
    //! @param     [in] bool_Force_Bad_Block_Erase - Force bad block erase
    //! @return    BOOL - Erase operation status
    //! @retval    false - Erase operation failed
    //! @retval    true - Erase operation successed
    //! \par       Override
    //!            Not requered
    //! @attention Erase operation not applied to the bad blocks.
    //--------------------------------------------------------------------------
 
    virtual BOOL Erase_Chip( BOOL bool_Force_Bad_Block_Erase );
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for specified block is bad and can not be utilised.
    //! @note      None
    //! @param     [in] u32_Block_Index - Block index to erase
    //! @param     [out] bool_Bad_Block_Status - Bad block status value
    //! @return    BOOL - Operation status
    //! @retval    false - Block is good
    //! @retval    true - Block is bad
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Bad_Block_Status( U32 u32_Block_Index, BOOL *bool_Bad_Block_Status );
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for specified block is empty and be utilised for write operation.
    //! @note      None
    //! @param     [in] u16_Block_Index - Block index to be test
    //! @return    BOOL - Operation status
    //! @retval    false - Block is not empty
    //! @retval    true - Block is empty
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Block_Empty( U16 u16_Block_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for specified page is empty and be utilised for write operation.
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Page is not empty
    //! @retval    true - Page is empty
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Page_In_Cache_Empty();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method sends actual driver information over specified communication link protocol.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the connunication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
  //---------------------------------------------------------------------------
  // Protected defines, methods and variables
  //---------------------------------------------------------------------------
 
  protected:
 
  //---------------------------------------------------------------------------
  // Private defines, methods and variables
  //---------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
    
    //! @brief Define chip types
    typedef enum
    {
 
      //! @brief No chip
      chip_type_None          = 0,
 
      //! @brief Unknown chip
      chip_type_Unknown       = 1,
 
      //! @brief 1 GBit, NAND, ISSI, IS37SML01G1
      chip_type_IS37SML01G1   = 2,
 
      //! @brief 4 GBit, NAND, GigaDevice, GD5F4GQ4UAYIG
      chip_type_GD5F4GQ4UAYIG = 3,
 
      //! @brief 512 MBit, NOR, SPANSION, S25FL512S
      chip_type_S25FL512S     = 4
 
    } TChip_Type;
 
    //! @brief Define NVRAM commands
    typedef enum
    {
 
      //! @brief Reset chip command
      commandRES    = (U8)0xFF,
 
      //! @brief Block erase command
      commandBE     = (U8)0xD8,
 
      //! @brief Get feature command
      commandGF     = (U8)0x0F,
 
      //! @brief Set feature  command
      commandSF     = (U8)0x1F,
 
      //! @brief Write disable command
      commandWRDI   = (U8)0x04,
 
      //! @brief Write enable command
      commandWREN   = (U8)0x06,
 
      //! @brief Page program command
      commandPP     = (U8)0x02,
 
      //! @brief Random page program command
      commandRPP    = (U8)0x84,
 
      //! @brief Program execute command
      commandPE     = (U8)0x10,
 
      //! @brief Read page command
      commandREAD   = (U8)0x13,
 
      //! @brief Read from cache (or 0x0B) command
      commandRFC    = (U8)0x03,
 
      //! @brief Read manufacture ID, memory type ID, capacity ID command
      commandRDID   = (U8)0x9F,
 
      //! @brief Read from cache x2 command
      command2RFC   = (U8)0x3B,
 
      //! @brief Random page program x4 command
      command4RPP   = (U8)0x34,
 
      //! @brief Read from cache x4 command
      command4RFC   = (U8)0x6B,
 
    } TS25FL512SCommand;
 
    //! @brief Feature address list
    typedef enum TS25FL512SAdress
    {
 
      //! @brief Block lock register address
      address_BL  = (U8)0xA0,
      
      //! @brief OTP register address
      address_OTP = (U8)0xB0,       
      
      //! @brief Status register address
      address_SR  = (U8)0xC0,
      
      //! @brief Output data register address
      address_OD  = (U8)0xD0
 
    } TS25FL512SAdress;
 
    //! @brief Status register structure
    typedef union
    {
 
        //! @brief Raw data
        U8 u8_Raw_Data;
 
        //! @brief Bitfield structure
        struct
        {
 
          //! @brief Bit 0 : Operation in progress bit
          U8 bit_Operation_In_Progress:1;
 
          //! @brief Bit 1 :Write enable latch bit
          U8 bit_Write_Enable_Latch:1;
 
          //! @brief Bit 2 : Erase fail bit
          U8 bit_Erase_Fail:1;
 
          //! @brief Bit 3 Program fail bit
          U8 bit_Program_Fail:1;
 
          //! @brief Bit 4 and 5 :ECC status bits
          U8 bits_ECC_Status:2;
 
          //! @brief Bit 6 : Not in use
          U8 :1;
 
          //! @brief Bit 7 : Not in use
          U8 :1;
 
        };
 
    } TStatus_Register;
 
    //! @brief Block lock register structure
    typedef union
    {
 
        //! @brief Raw data
        U8 u8_Raw_Data;
 
        //! @brief Bitfield structure
        struct
        {
 
          //! @brief Bit 0 : Not in use
          U8 :1;
 
          //! @brief Bit 1 : Not in use
          U8 :1;
 
          //! @brief Bit 2 : Not in use
          U8 :1;
 
          //! @brief Bit 3 Not in use
          U8 :1;
 
          //! @brief Bit 4 : BP1
          U8 BP1:1;
 
          //! @brief Bit 5 : BP2
          U8 BP2:1;
 
          //! @brief Bit 6 : Not in use
          U8 :1;
 
          //! @brief Bit 7 : BRWD
          U8 BRWD:1;
 
        };
 
    } TBlock_Register;
 
    //--------------------------------------------------------------------------
    // Private methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Enable write operation into memory.
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Operation successed
    //! @retval    true - Operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Write_Enable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable write operation into memory.
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Operation successed
    //! @retval    true - Operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Write_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read memory device status register method.
    //! @note      None
    //! @param     [out] *u8_Status_Register - Pointer to status register value
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Status_Register( U8 *u8_Status_Register );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get flash memory feature method.
    //! @note      None
    //! @param     [in] enum_Feature_Adress - Chip feature address
    //! @param     [out] u8_Data - Chip feature value
    //! @return    BOOL - Get operation status
    //! @retval    false - Get operation successed
    //! @retval    true - Get operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Feature( TS25FL512SAdress enum_Feature_Adress, U8 *u8_Data );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set flash memory feature method.
    //! @note      None
    //! @param     [in] enum_Feature_Adress - Chip feature address
    //! @param     [in] u8_Data - Chip feature value
    //! @return    BOOL - Set operation status
    //! @retval    false - Set operation successed
    //! @retval    true - Set operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Set_Feature( TS25FL512SAdress enum_Feature_Adress, U8 u8_Data );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read memory device identification information method.
    //! @note      None
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed
    //! @retval    true - Read operation failed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Identification();
 
    //!-------------------------------------------------------------------------
    //! @brief     Software reset memory chip method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Reset();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read multiple byte from chip cache method.
    //! @note      None
    //! @param     [in] u32_Address - Start address in cache
    //! @param     [in] u32_Length - Amount of the byte to read
    //! @param     [in] u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed
    //! @retval    true - Read operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Page_From_Cache_By_Leniar_Address( U32 u32_Address, U32 u32_Length, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read multiple byte from chip cache method.
    //! @note      None
    //! @param     [in] u16_Offset - Address offset in cache
    //! @param     [in] u32_Length - Amount of the byte to read
    //! @param     [in] u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed
    //! @retval    true - Read operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Page_From_Cache( U16 u16_Offset, U32 u32_Length, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write multiple byte into chip cache method.
    //! @note      None
    //! @param     [in] u32_Address - Start address in cache
    //! @param     [in] u32_Length - Amount of the byte to write
    //! @param     [in] u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation successed
    //! @retval    true - Write operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Write_Page_To_Cache_By_Leniar_Address( U32 u32_Address, U32 u32_Length, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write multiple byte into chip cache method.
    //! @note      None
    //! @param     [in] u16_Offset - Address offset in cache
    //! @param     [in] u32_Length - Amount of the byte to write
    //! @param     [in] u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation successed
    //! @retval    true - Write operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Write_Page_To_Cache( U16 u16_Offset, U32 u32_Length, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read page from chip cells into the cache method.
    //! @note      None
    //! @param     [in] u32_Linear_Address - Linear address of the page to read
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed
    //! @retval    true - Read operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Page_From_Cells_To_Cache( U32 u32_Linear_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read page from chip cells into the cache method. Page referenced by absolute page index within memory chip.
    //! @note      None
    //! @param     [in] u32_Page_Index - Absolute index of the page to read
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed
    //! @retval    true - Read operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Read_Page_From_Cells_To_Cache_By_Index( U32 u32_Page_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write page from cache into chip cells method.
    //! @note      None
    //! @param     [in] u32_Linear_Address - Linear address of the page to write
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation successed
    //! @retval    true - Write operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Write_Page_From_Cache_To_Cells( U32 u32_Linear_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write page from cache into chip cells method.
    //! @note      None
    //! @param     [in] u32_Page_Index - Absolute indes og the page to write
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation successed
    //! @retval    true - Write operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Write_Page_From_Cache_To_Cells_By_Page_Index( U32 u32_Page_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get write protection bits.
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Operation successed
    //! @retval    true - Operation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Write_Protection_Bits();
 
    //!-------------------------------------------------------------------------
    //! @brief     Wait specified time for hardware controller operation done method.
    //! @note      None
    //! @param     [in] f32_Timeout - Timeout in seconds
    //! @return    BOOL - Operation status
    //! @retval    false - Hardware controller perform operation in specified time
    //! @retval    true - Hardware controller not perform operation in specified time
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Wait_For_Operation_Done( F32 f32_Timeout );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get operation status method.
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Operation completed
    //! @retval    true - Operation in progress
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Operation_In_Progress();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get read operation status method.
    //! @note      None
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation successed without any errors
    //! @retval    true - Read oparation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Read_Failure();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get erase operation status method.
    //! @note      None
    //! @return    BOOL - Erase operation status
    //! @retval    false - Erase operation successed without any errors
    //! @retval    true - Erase oparation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Erase_Failure();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get program operation status method.
    //! @note      None
    //! @return    BOOL - Program operation status
    //! @retval    false - Program operation successed without any errors
    //! @retval    true - Program oparation failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Program_Failure();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment block erase request counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Block_Erase_Request_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment block erase error counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Block_Erase_Error_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment page read request counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Page_Read_Request_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment page read error counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Page_Read_Error_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment page write request counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Page_Write_Request_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment page write error counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Page_Write_Error_Counter();
    
    //-------------------------------------------------------------------------
    // Test functionality
    //-------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Erase block test method.
    //! @note      None
    //! @return    TReturn_Test_Code - Detail test status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
public: TReturn_Test_Code QA_Erase_Block_Test(); // Temp ver (public)
    
    //!-------------------------------------------------------------------------
    //! @brief     Write page test method.
    //! @note      None
    //! @return    TReturn_Test_Code - Detail test status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
public:    TReturn_Test_Code QA_Write_Page_Test();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read page test method.
    //! @note      None
    //! @return    TReturn_Test_Code - Detail test status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TReturn_Test_Code QA_Read_Page_Test();
    
    
    //!-------------------------------------------------------------------------
    //! @brief     Single block erase test method.
    //! @note      None
    //! @return    TReturn_Test_Code - Detail test status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    TReturn_Test_Code QA_Single_Block_Erase_Test();
    
    //!-------------------------------------------------------------------------
    //! @brief     Method for starting the main test sequence.
    //! @note      None
    //! @return    TReturn_Test_Code - Detail test status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    TReturn_Test_Code QA_Flash_Driver_Main_Test();
   
    //-------------------------------------------------------------------------
    // Private variables
    //-------------------------------------------------------------------------
 
    //! @brief Flash chip type storage
    TChip_Type enum_Flash_Chip_Type = chip_type_None;
 
    //! @brief Manufacturer number  storage
    U8 u8_Manufacturer_ID = (U8)0xFF;
 
    //! @brief Serial number storage
    U8 u8_Device_ID = (U8)0xFF;
 
    //! @brief JEDEC code storage
    volatile U8 u8_JEDEC_ID[ 3 ] = { (U8)0xFF, (U8)0xFF, (U8)0xFF };
 
    //! @brief Read identifier dummy byte counter
    //! @note ANVILEX KM: u32_Identifier_Dummy_Byte_Counter is used only for debug purpouse, and can optimised.
    U32 u32_Identifier_Dummy_Byte_Counter = (U32)0;
 
    //! @brief BP1 bit in BL register
    U8 u8_BP1 = (U8)0x00;
 
    //! @brief BP2 bit in BL register
    U8 u8_BP2 = (U8)0x00;
 
    //! @brief BRWD bit in BL register
    U8 u8_BRWD = (U8)0x00;
 
    //! @brief Block erase request counter
    U32 u32_Block_Erase_Request_Counter = (U32)0;
 
    //! @brief Block read error counter
    U32 u32_Block_Erase_Error_Counter = (U32)0;
 
    //! @brief Page read request counter
    U32 u32_Page_Read_Request_Counter = (U32)0;
 
    //! @brief Page read error counter
    U32 u32_Page_Read_Error_Counter = (U32)0;
 
    //! @brief Page write request counter
    U32 u32_Page_Write_Request_Counter = (U32)0;
 
    //! @brief Page write error counter
    U32 u32_Page_Write_Error_Counter = (U32)0;
 
    //! @brief Bad block search counter
    U16 u16_Bad_Block_Counter = (U16)0;
 
    //! @brief Bad block count
    U16 u16_Bad_Block_Count = (U16)0;
 
    //! @brief Actual block index of the search bad block count process
    U16 u16_Execute_Bad_Block_Count_Index = (U16)0;
    
    //! @brief Actual block index of the search bad block count process
    //! @todo ANVILEX KM: Investigate of this buffer purpoise
    U8 u8_Test_Buffer[ 2048 ];
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------