FLASH_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       FLASH_STM32F429.h
//! @brief      STM32F429 on-chip flash module 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/Targets/STM32F429/FLASH_STM32F429.h $
//!             $Revision: 2766 $
//!             $Date: 2021-07-04 17:26:00 +0500 (Вс, 04 июл 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include project files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 on-chip flash module class
class TFLASH_STM32F429
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Flash chip initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Flash chip finalisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read data from memory into buffer.
    //! @note      None
    //! @param     [in] u32_Address - 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_Buffer( U32 u32_Address, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write data from buffer into memory.
    //! @note      None
    //! @param     [in] u32_Address - Address of the data in memory
    //! @param     [in] u32_Size - Size of the data to write
    //! @param     [in] *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( U32 u32_Address, U32 u32_Size, U8 *u8_Data_Buffer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Erase block referenced by index.
    //! @note      None
    //! @param     [in] u32_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( U32 u32_Block_Index );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //!-------------------------------------------------------------------------
    //! @brief     Flash chip unlock method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Unlock();
  
    //!-------------------------------------------------------------------------
    //! @brief     Flash chip lock method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Lock();
 
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------