DIO_STM32F410CBU6.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      DIO_STM32F410CBU6.h
//! @brief     STM32F410CBU6 digital I/O class header file.
//! @copyright ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P016_05_PUC2/DIO_STM32F410CBU6.h $
//!            $Revision: 2203 $
//!            $Date: 2020-11-21 14:58:09 +0500 (Sa, 21 Nov 2020) $
//!            $Author: minch $
//
// Copyright(C) 2015-2021 ANVILEX LLC
//
// 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 declarations
//------------------------------------------------------------------------------
 
//! @brief On chip digital I/O class
class TDIO_STM32F410CBU6
{
 
  //----------------------------------------------------------------------------
  // 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.
    //--------------------------------------------------------------------------
 
    TDIO_STM32F410CBU6();
  
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TDIO_STM32F410CBU6();
    
    //!-------------------------------------------------------------------------
    //! @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     Get digital input status method
    //! @note      None
    //! @param     [in] u8_Index - Digital input index
    //! @param     [out] *bool_Status - Digital input status
    //! @return    BOOL - Execution status
    //! @retval    false - Digital input not found
    //! @retval    true - Success
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Input( U8 u8_Index, BOOL *bool_Status );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set digital output method
    //! @note      None
    //! @param     [in] u8_Index - Digital output index
    //! @param     [in] bool_Status - Digital output status to set
    //! @return    BOOL - Execution status
    //! @retval    false - Digital output not found
    //! @retval    true - Success
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Set_Output( U8 u8_Index, BOOL bool_Status );
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------