FM25V02.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       FM25V02.h
//! @brief      NVRAM chip FM25V02 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/FM25V02.h $
//!             $Revision: 2904 $
//!             $Date: 2021-12-02 02:39:23 +0500 (Do, 02 Dez 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
//------------------------------------------------------------------------------
 
#define NVRAM_READY_TIMEOUT_MS  5  // 5us @ 20 MHz
 
//------------------------------------------------------------------------------
// Class
//------------------------------------------------------------------------------
 
//! @brief NVRAM memory hardware driver
class TFM25V02 : public TSPI_Memory_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
    
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    //! @brief device ID structure
    typedef union TDevice_ID
    {
      
      //! @brief Device ID buffer
      U8 u8_Device_ID[ 9 ];
      
      //! @brief Bitfield structure
      struct
      {
        
        //! @brief Device manufacturer ID
        U8 u8_Manufacturere_ID[ 7 ];
        
        //! @brief Device density and family structure
        struct
        {
          
          //! @brief Bits 4-0 : Device density
          U8 u8_Density:5;
          
          //! @brief Bits 7-5 : Device family
          U8 u8_Family:3;
          
        };
        
        //! @brief Device revision and subversion structure
        struct
        {
          
          //! @brief Bits 2-0 : Reserved bits
          U8 u8_Reserved:3;
          
          //! @brief Bits 5-3 : Device revision
          U8 u8_Revision:3;
          
          //! @brief Bits 7-6 : Device subversion
          U8 u8_Subtype:2;
          
        };
        
      };
      
    } TDevice_ID;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TFM25V02();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFM25V02();
          
    //!-------------------------------------------------------------------------
    //! @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     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     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_Linear_Address - Linear address
    //! @param     [in] u32_Size - Size of the data
    //! @param     [out] *u8_Data_Buffer - Pointer to the data buffer
    //! @return    BOOL - Oeration status
    //! @retval    false - Operation failed
    //! @retval    true - Operation successed
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Verify_Buffer( U32 u32_Linear_Address, U32 u32_Size, U8 *u8_Data_Buffer ); // ANVILEX KM: To implement 
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
  
    //! @brief Define NVRAM commands
    enum TNVRAMCommand 
    {
      //! @brief Write Enable Latch command
      commandWREN  = (U8)0x06,
    
      //! @brief Write Disable command
      commandWRDI  = (U8)0x04,
    
      //! @brief Read Status Register command
      commandRDSR  = (U8)0x05,
    
      //! @brief Write Status Register command
      commandWRSR  = (U8)0x01,
    
      //! @brief Read Memory Data command
      commandREAD  = (U8)0x03,
    
      //! @brief Fast Read Memory Data command
      commandFSTRD = (U8)0x0B,
    
      //! @brief Write Memory Data command
      commandWRITE = (U8)0x02,
    
      //! @brief Enter sleep mode command
      commandSLEEP = (U8)0xB9,
      
      //! @brief Read device ID command
      commandRDID  = (U8)0x9F,
      
      //! @brief Read device serial number command
      commandSNR   = (U8)0xC3
      
    };
    
    //--------------------------------------------------------------------------
    // Private methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @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     Write memory device status register method.
    //! @note      None
    //! @param     [in] u8_Status_Register - Status register value
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation failed
    //! @retval    true - Write operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Write_Status_Register( U8 u8_Status_Register );
    
    //!-------------------------------------------------------------------------
    //! @brief     Read byte from device method.
    //! @note      None
    //! @param     [in] u32_Address - Address
    //! @param     [out] *u8_Data - Pointer to returned data value
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Read_Memory( U32 u32_Address, U8 *u8_Data );
    
    //!-------------------------------------------------------------------------
    //! @brief     Write byte into device method.
    //! @note      None
    //! @param     [in] u32_Address - Address
    //! @param     [in] u8_Data - Data value
    //! @return    BOOL - Write operation status
    //! @retval    false - Write operation failed
    //! @retval    true - Write operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Write_Memory( U32 u32_Address, U8 u8_Data );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read memory device identification information method.
    //! @note      None
    //! @return    BOOL - Read operation status
    //! @retval    false - Read operation failed
    //! @retval    true - Read operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Identification();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read manufacturer identifier pure virtual method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
//    virtual BOOL Read_Manufacturer_ID();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read device identifier pure virtual method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Device_ID();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read device serial number pure virtual method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
    virtual BOOL Read_Serial_Number();
 
    //!-------------------------------------------------------------------------
    //! @brief     Exit from sleep mode.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
    VOID Exit_Sleep_Mode();
    
    //!-------------------------------------------------------------------------
    //! @brief     Address translation method.
    //! @note      None
    //! @param     [in] u32_Address - Address (4 bytes)
    //! @param     [out] *u8_Address_Size - Size of the address in bytes
    //! @param     [out] *u8_Address_Byte_2 - Address (2th byte)
    //! @param     [out] *u8_Address_Byte_1 - Address (1th byte)
    //! @param     [out] *u8_Address_Byte_0 - Address (0th byte)
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
    VOID Translate_Address( U32 u32_Address, U8 *u8_Address_Size, U8 *u8_Address_Byte_2, U8 *u8_Address_Byte_1, U8 *u8_Address_Byte_0 );
    
    //!-------------------------------------------------------------------------
    //! @brief     Address in range checking method.
    //! @note      None
    //! @param     [in] u32_Address - Address (4 bytes)
    //! @param     [in] u32_Size - Data size
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention Depricated method.
    //--------------------------------------------------------------------------
 
    BOOL Is_Address_In_Range( U32 u32_Address, U32 u32_Size );
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Serial number storage
    U8 u8_Serial_Number[ 8 ] = { (U8)0x00, (U8)0x00, (U8)0x00, (U8)0x00, (U8)0x00, (U8)0x00, (U8)0x00, (U8)0x00 };    
    
    //! @brief Memory device ID structure
    TDevice_ID struct_Device_ID; 
 
};
 
//------------------------------------------------------------------------------
// Export global objects
//------------------------------------------------------------------------------
 
//! @brief Export global NVRAM object
extern TFM25V02 object_FM25V02;
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------