UART1_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       UART1_STM32F429.h
//! @brief      STM32F429 on-chip UART1 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/UART1_STM32F429.h $
//!             $Revision: 2766 $
//!             $Date: 2021-07-04 17:26:00 +0500 (So, 04 Jul 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
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "Communication_Link.h"
 
//------------------------------------------------------------------------------
// Global defines
//------------------------------------------------------------------------------
 
//! @brief Definition of UART1 transmit buffer size
//! @note Don't use this define outside of this file.
#define UART1_TX_BUFFER_SIZE 256
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 on-chip UART1 hardware abstraction layer class.
class TUART1_STM32F429 : public TCommunication_Link
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Object initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Object finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Start RX operation.
    //! @note      Calling this method enables RX operation of the UART.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Start_RX_Operation();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop RX operation.
    //! @note      Calling this method enables RX operation of the UART.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Stop_RX_Operation();
 
    //!-------------------------------------------------------------------------
    //! @brief     Start TX operation.
    //! @note      Calling this method enables RX operation of the UART.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Start_TX_Operation();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop TX operation.
    //! @note      Calling this method enables RX operation of the UART.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Stop_TX_Operation();
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable interrupt method.
    //! @note      None
    //! @param     [in] u32_Priority - Interrupt priority
    //! @return    None
    //! \par       Override
    //!            Not allowed / Requered / Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Enable( U32 u32_Priority );
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed / Requered / Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Interrupt service method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed / Requered / Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit data method.
    //! @note      This method adds data to the internal queue.
    //! @param     [in] u8_Transmit_Value - Value for transmitting
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Data_Transmit( U8 u8_Transmit_Value );
 
  //----------------------------------------------------------------------------
  // Private methods, variables and definitions
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private type definitions
    //--------------------------------------------------------------------------
 
    //! @brief Send buffer structure datatype definition
    typedef struct
    {
 
      //! @brief Data section
      U8 u8_Data;
 
      //! @brief Displaying readiness for recording
      BOOL bool_Data_Status;
 
    } TSend_Buffer;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief RX operation enabled status flag
    BOOL bool_RX_Operation_Enabled;
 
    //! @brief TX operation enabled status flag
    BOOL bool_TX_Operation_Enabled;
 
    //! @brief Transmiting active status flag
    volatile BOOL bool_Transmiting_Active;
 
    //! @brief Buffer for data transmitting
    volatile TSend_Buffer struct_Send_Buffer[ UART1_TX_BUFFER_SIZE ];
 
    //! @brief Count for struct_Send_Buffer
    volatile U16 u16_Buffer_Count;
 
    //! @brief Count data index for transmiting
    volatile U16 u16_Transmission_Data_Index;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------