SPI_Master_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       SPI_Master_Base.h
//! @brief      SPI bus master base 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/Engine/SPI_Master_Base.h $
//!             $Revision: 2821 $
//!             $Date: 2021-07-26 18:16:22 +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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include project files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief SPI master base class
class TSPI_Master_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TSPI_Master_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TSPI_Master_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     SPI bus initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     SPI bus finalisation method
    //! @note      Override method must initialise hardware dependent SPI bus unit and related GPIO.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Init() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO reinitialisation as GPIO method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Done() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Start SPI bus operation method
    //! @note      Start SPI bus opearation.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop SPI bus operation method
    //! @note      Stops SPI bus operation.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Stop() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Activate (set to 0) SPI bus chip select signal
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID CS_Activate() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Deactivate (set to 1) SPI bus chip select signal
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID CS_Deactivate() = 0;
 
    //!-------------------------------------------------------------------------
    //! @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
    //!            Requered
    //! @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
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Byte( U8 u8_Byte_To_Send ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @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
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_Byte( U8 *u8_Byte_To_Receive ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Verify byte over SPI bus
    //! @note      None
    //! @param     [in] u8_Byte_To_Verify - Byte to verify
    //! @return    BOOL - Verify 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 ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Send buffer and receive buffer over SPI bus at some time
    //! @note      None
    //! @param     [in] *u8_Buffer_To_Send - Pointer to the buffer to send
    //! @param     [in] *u8_Buffer_To_Receive - Pointer to the buffer to receive
    //! @param     [in] u16_Length - Length of the send and receive buffer.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Length of the send and length of the receive buffer must be the equal.
    //--------------------------------------------------------------------------
 
    VOID Transfer_Buffer( U8 *u8_Buffer_To_Send, U8 *u8_Buffer_To_Receive, U16 u16_Length );
    
    //!-------------------------------------------------------------------------
    //! @brief     Set transmit mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Set_Transmit_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set receive mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Set_Receive_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set MOSI in high state
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Set_MOSI();
    
    //!-------------------------------------------------------------------------
    //! @brief     Set MOSI in low state
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Clear_MOSI();
    
    //!-------------------------------------------------------------------------
    //! @brief     Set clock in low state
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Clear_Clock();
    
    //!-------------------------------------------------------------------------
    //! @brief     Set clock in high state
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Set_Clock();
    
    //!-------------------------------------------------------------------------
    //! @brief     Get MISO pin state
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Get_MISO();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
  
    //! @brief Object initialisation status
    BOOL bool_Initialised = (BOOL)false;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------