CRC_16_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      CRC_16_Base.h
//! @brief     Cyclic reduncancy check (CRC-16) base class header file.
//! @copyright (C)2015-2020 ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/CRC_16_Base.h $
//!            $Revision: 2797 $
//!            $Date: 2021-07-12 16:13:33 +0500 (Mo, 12 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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definition
//------------------------------------------------------------------------------
 
//! @brief Cyclic redundancy check (CRC-16) base class
class TCRC_16_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Get initial value of CRC
    //! @note      None
    //! @return    U16 - CRC initial value
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCRC_16_Base__Init.dt
    //--------------------------------------------------------------------------
 
    virtual U16 Init() = 0;
      
    //!-------------------------------------------------------------------------
    //! @brief     Check CRC of the data buffer
    //! @note      None
    //! @param     [in] *void_Data - Pointer to the data buffer
    //! @param     [in] u32_Size - Size of the data buffer
    //! @param     [in] u16_Expected_CRC - Expected CRC of the data buffer  
    //! @return    BOOL - Data buffer CRC checking status
    //! @retval    false - CRC of the buffer not match to expected CRC
    //! @retval    true - CRC of the buffer match to expected CRC
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCRC_16_Base__Check.dt
    //--------------------------------------------------------------------------
 
    BOOL Check( VOID *void_Data, U32 u32_Size, U16 u16_Expected_CRC );
  
    //!-------------------------------------------------------------------------
    //! @brief     Calculate CRC of the data buffer
    //! @note      None
    //! @param     [in] *void_Data - Pointer to the data buffer
    //! @param     [in] u32_Size - Size of the data buffer
    //! @return    U16 - Calculated CRC of the data buffer
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCRC_16_Base__Calculate.dt
    //--------------------------------------------------------------------------
 
    virtual U16 Calculate( VOID *void_Data, U32 u32_Size );
  
    //!-------------------------------------------------------------------------
    //! @brief     Update CRC with new data value
    //! @note      None
    //! @param     [in, out] &u16_CRC - Actual CRC value
    //! @param     [in] u8_Data - Data value
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCRC_16_Base__Update.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Update( U16 &u16_CRC, U8 u8_Data ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Test CRC calulation
    //! @note      None
    //! @return    TRIL - Test CRC calculation status
    //! @retval    unset - Test method not implemented
    //! @retval    false - Test CRC calculation failed
    //! @retval    true - Test CRC calculation successed
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly
    //! \par       UML diagram
    //! @dotfile   TCRC_16_Base__Test.dt
    //--------------------------------------------------------------------------
 
    virtual TRIL Test();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------