SPI5_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       SPI5_STM32F429.h
//! @brief      STM32F429 on-chip SPI5 bus master 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/SPI5_STM32F429.h $
//!             $Revision: 2820 $
//!             $Date: 2021-07-26 18:14:38 +0500 (Mo, 26 Jul 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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
//------------------------------------------------------------------------------
 
#include "SPI_Master_Base.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 on-chip SPI5 bus master module class
class TSPI5_STM32F429 : public TSPI_Master_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
/*
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TSPI5_STM32F429();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TSPI5_STM32F429();
*/
    //!-------------------------------------------------------------------------
    //! @brief     SPI bus initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Start SPI bus operation method
    //! @note      Start SPI bus opearation.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop SPI bus operation method
    //! @note      Stops SPI bus operation.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Stop();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send byte and receive byte over SPI bus at some time
    //! @note      None
    //! @param     [in] u8_Byte_To_Send - Byte to send
    //! @param     [in] *u8_Byte_To_Receive - Pointer to the byte to receive
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Transfer_Byte( U8 u8_Byte_To_Send, U8 *u8_Byte_To_Receive );
 
    //!-------------------------------------------------------------------------
    //! @brief     Send byte over SPI bus
    //! @note      None
    //! @param     [in] u8_Byte_To_Send - Byte to send
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Byte( U8 u8_Byte_To_Send );
 
    //!-------------------------------------------------------------------------
    //! @brief     Receive byte over SPI bus
    //! @note      Function sent 0x00 over SPI bus during receiving.
    //! @param     [in] *u8_Byte_To_Receive - Pointer to the byte to receive
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_Byte( U8 *u8_Byte_To_Receive );
 
    //!-------------------------------------------------------------------------
    //! @brief     Verify byte over SPI bus
    //! @note      None
    //! @param     [in] u8_Byte_To_Verify - Byte to verify
    //! @return    BOOL - Operation status
    //! @retval    false - Verification error, bytes is different
    //! @retval    true - Verification cuccessed, bytes is equal
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Verify_Byte( U8 u8_Byte_To_Verify );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
  //! @brief Timeout for byte sending 5 ms
  const U32 u32_Send_Byte_Timeout = (U32)5;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------