CAN2_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       CAN2_STM32F429.h
//! @brief      STM32F429 on-chip CAN2 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/CAN2_STM32F429.h $
//!             $Revision: 2819 $
//!             $Date: 2021-07-26 17:23:01 +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 standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Communication_Link.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 on-chip CAN1 hardware abstraction layer class.
class TCAN2_STM32F429 : public TCommunication_Link
{
 
  //----------------------------------------------------------------------------
  // 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.
    //--------------------------------------------------------------------------
 
    TCAN2_STM32F429();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TCAN2_STM32F429();
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Interrupt enable method.
    //! @note      None
    //! @param     [in] u32_Priority - Interrupt priority level
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Enable( U32 u32_Priority );
 
    //!-------------------------------------------------------------------------
    //! @brief     CAN2 interrupt disable method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     CAN2 RX interrupt processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID RX0_Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit test data
    //! @note      None
    //! @param     [in] u32_ID - Identifier
    //! @param     [in] u8_ID_Type - Message type (0-Standart ID, 1-Extended ID)
    //! @param     [in] *u8_Transmit_Buffer - Pointer to the data buffer
    //! @param     [in] *u8_Transmit_Length - Data size
    //! @return    BOOL - Operation status
    //! @retval    false - Transmiting error
    //! @retval    true - Transmiting successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Transmit_Data_Test( U32 u32_ID, U8 u8_ID_Type, U8 *u8_Transmit_Buffer, U8 u8_Transmit_Length );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Communication data transmit method
    //! @note      None
    //! @param     [in] u32_ID - Identifier
    //! @param     [in] u8_ID_Type - Message type (0-Standart ID, 1-Extended ID)
    //! @param     [in] *u8_Transmit_Buffer - Pointer to the data buffer
    //! @param     [in] *u8_Transmit_Length - Data size
    //! @return    BOOL - Operation status
    //! @retval    false - Transmiting error
    //! @retval    true - Transmiting successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Transmit_Data( U32 u32_ID, U8 u8_ID_Type, U8 *u8_Transmit_Buffer, U8 u8_Transmit_Length );
  
    //!-------------------------------------------------------------------------
    //! @brief     CAN2 RX interrupt processing method.
    //! @note      None
    //! @param     [in] *void_Transmit_Data - Pointer to the data buffer
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
  
    virtual VOID Communication_Block_Data_Transmit( VOID *void_Transmit_Data );
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Initialisation error flag.
    BOOL bool_Initialisation_Error = (BOOL)false;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------