P016_26_KG3_TSA.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P016_26_KG3_TSA.h
//! @brief      Board P016.26 hardware driver header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P016_26_KG3_TSA/P016_26_KG3_TSA.h $
//!             $Revision: 2268 $
//!             $Date: 2020-12-06 14:59:59 +0500 (So, 06 Dez 2020) $
//!             $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.
//
//------------------------------------------------------------------------------
//
// TP016_26_KG3_TSA_T1
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Functional_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//!------------------------------------------------------------------------------
//! @brief Analog current input KG3 BLA T1 (P018.39) board class
//------------------------------------------------------------------------------
 
class TP016_26_KG3_TSA_T1 : public TFunctional_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      // Unit identification registers
      U16 u16_Unit_ID_L;            //!< 0x00 : Module identification register
      U16 u16_Unit_ID_H;            //!< 0x01 : Module identification register
 
      U16 u16_Unused_0x02;          //!< 0x02 : Reserved register
      U16 u16_Unused_0x03;          //!< 0x03 : Reserved register
 
      U16 u16_Control_Register;     //!< 0x04 : Control register
      U16 u16_Status_Register;      //!< 0x05 : Control register
      
      U16 u16_ISP_Data_1;           //!< 0x06 : ISP data 1 register
      U16 u16_ISP_Data_2;           //!< 0x07 : ISP data 2 register
      U16 u16_ISP_Data_3;           //!< 0x08 : ISP data 3 register
      U16 u16_ISP_Data_4;           //!< 0x09 : ISP data 4 register
    
    } TP016_26_KG3_TSA_T1_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP016_26_KG3_TSA_T1(); //!< Class constructor method
    ~TP016_26_KG3_TSA_T1(); //!< Class destructor method
 
    VOID Map( TP016_26_KG3_TSA_T1_Registers *struct_Registers_Base_Address ); //!< Hardware map method
    virtual VOID Init(); //!< Block initialisation method
    virtual VOID Execute(); //!< Block execution method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information method
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Sample_Time; //!< Functional block sample time input
                           
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_bool_LED_Red_Enable; //!<
    TBlock_Input_Connector object_bool_LED_Yellow_Enable; //!<
    TBlock_Input_Connector object_bool_LED_Green_Enable; //!<
 
    TBlock_Input_Connector object_bool_ISP_Connect; //!<
    TBlock_Input_Connector object_bool_ISP_Reset; //!<
 
    TBlock_Input_Connector object_u16_Command;
    TBlock_Input_Connector object_bool_Start;
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_bool_Processed;
    TBlock_Output_Connector object_bool_Status;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef enum
    {
    
      enum_Init, //!< Initialisation state
      enum_Ready, //!< Ready state
      enum_Done,
 
      enum_Programming_Enable,
      enum_Programming_Enable_Wait,
      enum_Programming_Enable_Done,
 
      enum_Read_Device_Signature,
      enum_Read_Device_Signature_Wait,
      enum_Read_Device_Signature_Done,
      
      enum_Chip_Erase,
      enum_Chip_Erase_Wait,
      enum_Chip_Erase_Done,
      
      enum_Load_Program_Memory,
      enum_Load_Program_Memory_Wait,
      enum_Write_Program_Memory_Wait,
      enum_Write_Program_Memory_Done,
 
      enum_Read_Program_Memory,
      enum_Read_Program_Memory_Wait,
      enum_Read_Program_Memory_Done,
 
      enum_Error
      
    } TGlobal_FSM_State; //!< FSM state definition
 
    typedef union
    {
      
      U16 u16_Status;
      struct
      {
        
        U16 u16_Sensor_LED_Red:1;   // Bit 0
        U16 u16_Sensor_LED_Green:1; // Bit 1
        U16 :1;                     // Bit 2
        U16 :1;                     // Bit 3
        
        U16 :1;                     // Bit 4
        U16 :1;                     // Bit 5
        U16 :1;                     // Bit 6
        U16 :1;                     // Bit 7
        
        U16 :1;                     // Bit 8
        U16 :1;                     // Bit 9
        U16 u16_ISP_Ready:1;        // Bit 10
        U16 :1;                     // Bit 11
        
        U16 :1;                     // Bit 12
        U16 :1;                     // Bit 13
        U16 u16_ISP_MISO:1;         // Bit 14
        U16 :1;                     // Bit 15
        
      };
      
    } TStatus_Register;
 
    typedef union
    {
      U16 u16_Control;
      struct
      {
        U16 u16_LED_Red:1;      // Bit 0
        U16 u16_LED_Yellow:1;   // Bit 1
        U16 u16_LED_Green:1;    // Bit 2
        U16 :1;                 // Bit 3
        U16 u16_Clock_Enable:1; // Bit 4
        U16 :1;                 // Bit 5
        U16 :1;                 // Bit 6
        U16 :1;                 // Bit 7
        U16 u16_ISP_Enable:1;   // Bit 8
        U16 u16_ISP_Mode:1;     // Bit 9
        U16 u16_ISP_Start:1;    // Bit 10
        U16 u16_ISP_Reset:1;    // Bit 11
        U16 u16_ISP_SCK:1;      // Bit 12
        U16 u16_ISP_MOSI:1;     // Bit 13
        U16 :1;                 // Bit 14
        U16 :1;                 // Bit 15
      };
    } TControl_Register;
 
    volatile TP016_26_KG3_TSA_T1_Registers *struct_Registers; //!< Hardware mapped registers
 
    TGlobal_FSM_State enum_FSM_State; //!< FSM state
 
    TControl_Register struct_Control_Register;
    TStatus_Register struct_Status_Register;
    
    U32 u32_Chip_Erase_Time;
    
    U32 u32_Delay_Counter;
    U32 u32_Byte_Counter;
    U32 u32_Page_Counter;
    U32 u32_Program_Memory_Buffer_Index;
    U8 u8_Device_Signature[ 4 ];
    
    U8 u8_Program_Memory_Write_Data[ 1024 ];
    U8 u8_Program_Memory_Read_Data[ 1024 ];
    
    VOID ISP_Send_Progrsmming_Enable_Command();
    VOID ISP_Send_Chip_Erase_Command();
    
};
  
//------------------------------------------------------------------------------
// End Of File 
//------------------------------------------------------------------------------