Parameter_Base_Defines.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Parameter_Base_Defines.h
//! @brief      Parameter database defines header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2019-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Defines/Parameter_Base_Defines.h $
//!             $Revision: 2508 $
//!             $Date: 2021-03-19 15:23:33 +0500 (Fr, 19 Mrz 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 system files
//------------------------------------------------------------------------------
 
#include "ConOpSys_Variant.h"
//#include "Parameter_Base.h"
 
//------------------------------------------------------------------------------
// Defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Parameter local access mode
//------------------------------------------------------------------------------
// Value size: 3 bit
//------------------------------------------------------------------------------
 
//! @brief Parameter local access mode enumeration
enum TParameter_Access_Mode
{
 
  //! @brief Unknown access mode
  access_mode_Unknown = 0, 
  
  //! @brief Read on constant access mode
  access_mode_Constant = 1, 
  
  //! @brief Read only access mode
  access_mode_Read_Only = 2, 
  
  //! @brief Write only access mode
  access_mode_Write_Only = 3, 
  
  //! @brief Read and write access mode
  access_mode_Read_Write = 4, 
 
  //! @brief No access mode
  access_mode_No_Access = 5 
  
};
 
//------------------------------------------------------------------------------
// Parameter remote access mode
//------------------------------------------------------------------------------
// Value size: 2 bits
//------------------------------------------------------------------------------
 
//! @brief Parameter remote access mode enumeration
enum TRemote_Parameter_Access_Mode
{
 
  //! @brief Unknown access mode
  enum_Unknown = 0, 
    
  //! @brief Read access mode
  enum_Read = 1, 
  
  //! @brief Write access mode
  enum_Write = 2, 
  
  //! @brief No access mode
  enum_No_Access = 3 
  
};
 
//------------------------------------------------------------------------------
// Parameter access level
//------------------------------------------------------------------------------
// Value size: 4 bit
//------------------------------------------------------------------------------
 
///-----------------------------------------------------------------------------
/*
typedef enum
{
  access_level_No_Access = 0,
  access_level_Guest = 1,
  access_level_User = 2,
  access_level_Service = 3,
  access_level_Developer = 5
} Parameter_Access_Level;
*/
///-----------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Parameter boundary check mode enumerator
//------------------------------------------------------------------------------
// Value size: 4 bit
//------------------------------------------------------------------------------
 
//! @brief Parameter boundary check mode enimeration
enum TParameter_Boundary_Check_Mode
{
  
  //! @brief Unknown limit checking mode. Typical not allowed condition
  check_mode_Unknown = 0, 
  
  //! @brief No limit check
  check_mode_No_Check = 1, 
  
  //! @brief User defined limit check, boundary check routine must be implemented by user
  check_mode_User = 2, 
  
  //! @brief Less as
  check_mode_Less = 3,
  
  //! @brief Less or equal as
  check_mode_LessEqual = 4, 
  
  //! @brief Greater as
  check_mode_Greater = 5,
  
  //! @brief Greater or equal as
  check_mode_GreaterEqual = 6, 
  
  //! @brief Less and greater as
  check_mode_Less_Greater = 7, 
  
  //! @brief Less and greater or equal as
  check_mode_Less_GreaterEqual = 8,
  
  //! @brief Less or equal and greater as
  check_mode_LessEqual_Greater = 9,
  
  //! @brief Less or equal and greater or equal as
  check_mode_LessEqual_GreaterEqual = 10 
 
};
 
//------------------------------------------------------------------------------
// Parameter display format
//------------------------------------------------------------------------------
// Value size: 4 bit
//------------------------------------------------------------------------------
 
//! @brief Parameter fisplay format enumeration
enum TParameter_Display_Format
{
  
  //! @brief Native format
  display_format_Native = 0,
  
  //! @brief Decimal format
  display_format_Decimal = 1, 
  
  //! @brief Hexadecimal format
  display_format_Hexadecimal = 2, 
  
  //! @brief Octal format
  display_format_Octal = 3, 
  
  //! @brief Binary format
  display_format_Binary = 4,
  
  //! @brief Enumeration format
  display_format_Enumeration = 5, 
  
  //! @brief True/False format
  display_format_Boolean_True_False = 6, 
  
  //! @brief On/Off format
  display_format_Boolean_On_Off = 7, 
  
  //! @brief Enable/Disable format
  display_format_Boolean_Enable_Disable = 8, 
  
  //! @brief Scentific format
  display_format_Scientific = 9, 
  
  //! @brief BCD format
  display_format_Binary_Coded_Decimal = 10, 
  
  //! @brief IPv4 format
  display_format_IP_V4 = 11,
  
  //! @brief IPv6 format
  display_format_IP_V6 = 12
 
};
 
//------------------------------------------------------------------------------
// Parameter display fraction digits
//------------------------------------------------------------------------------
 
//! @brief Parameter display fraction number enumeration
enum TParameter_Display_Fraction_Digit
{
  
  //! @brief Show all possible digits
  display_fraction_digits_All_Digits = 0,
  
  //! @brief Show 0 digits of the fraction part
  display_fraction_digits_0_Digits = 1,
  
  //! @brief Show 1 digit of the fraction part
  display_fraction_digits_1_Digits = 2,
  
  //! @brief Show 2 digits of the fraction part
  display_fraction_digits_2_Digits = 3,
  
  //! @brief Show 3 digits of the fraction part
  display_fraction_digits_3_Digits = 4,
  
  //! @brief Show 4 digits of the fraction part
  display_fraction_digits_4_Digits = 5,
  
  //! @brief Show 5 digits of the fraction part
  display_fraction_digits_5_Digits = 6,
  
  //! @brief Show 6 digits of the fraction part
  display_fraction_digits_6_Digits = 7,
  
  //! @brief Show 7 digits of the fraction part
  display_fraction_digits_7_Digits = 8,
  
  //! @brief Show 8 digits of the fraction part
  display_fraction_digits_8_Digits = 9,
  
  //! @brief Show 9 digits of the fraction part
  display_fraction_digits_9_Digits = 10,
  
  //! @brief Show 10 digits of the fraction part
  display_fraction_digits_10_Digits = 11,
  
  //! @brief Show 11 digits of the fraction part
  display_fraction_digits_11_Digits = 12,
  
  //! @brief Show 12 digits of the fraction part
  display_fraction_digits_12_Digits = 13,
  
  //! @brief Show 13 digits of the fraction part
  display_fraction_digits_13_Digits = 14,
  
  //! @brief Show 14 digits of the fraction part
  display_fraction_digits_14_Digits = 15,
   
  //! @brief Show 15 digits of the fraction part
  display_fraction_digits_15_Digits = 16
 
};
 
//------------------------------------------------------------------------------
// Parameter initialisation status defines
//------------------------------------------------------------------------------
 
//! @brief Parameter initialisation source status enumeration
enum TParameter_Initialisation_Status
{
  
  //! @brief Parameter value not initialised
  enum_Uninitialised = 0,
  
  //! @brief Parameter value initialised from default value
  enum_Default_Initialised = 1,
  
  //! @brief Parameter value initialised from value stored in media
  enum_Media_Initialised = 2,
  
  //! @brief Parameter value initialisation error
  enum_Initialisation_Error = 3
  
};
 
//------------------------------------------------------------------------------
// Parameter storage type
//------------------------------------------------------------------------------
 
//! @brief Parameter storage type enumeration
enum TParameter_Storage_Type
{
  
  //! @brief Parameter storage typr unknown or undefined
  pst_enum_Unknown = 0,
  
  //! @brief Volatile parameter
  pst_enum_Volatile = 1,
  
  //! @brief Nonvolatile parameter
  pst_enum_Nonvolatile = 2,
  
  //! @brief Quasivolatile parameter
  pst_enum_Quasivolatile = 3
 
};
 
//------------------------------------------------------------------------------
// Parameter descriptor related definitions
//------------------------------------------------------------------------------
 
class TParameter_Base;
 
//! @brief Parameter extended description structure definition
typedef struct
{
 
  //! @brief Minimum value
  TConOpSys_Variant_Data struct_Minimum_Value; 
  
  //! @brief Maximum value
  TConOpSys_Variant_Data struct_Maximum_Value; 
  
  //! @brief Default value
  TConOpSys_Variant_Data struct_Default_Value; 
 
} TParameter_Extended_Descriptor_Base;
 
//------------------------------------------------------------------------------
 
//! @brief Parameter dimension descriptor
typedef struct
{
  
  //! @brief Unique dimension index
  U32 u32_Dimension_Index;
 
  //! @brief Dimension size given in elements
  U32 u32_Dimension_Size;
 
} TParameter_Dimension_Descriptor;
 
//------------------------------------------------------------------------------
 
//! @brief Parameter description structure definition
typedef struct
{
  
  //! @brief Pointer to parameter name
  //! @note Size: 4 byte
  const C8 *c8_Name; 
  
  //! @brief Pointer to parameter group name
  //! @note Size: 4 byte
  const C8 *c8_Group; 
  
  //! @brief Pointer to parameter description: 4 byte
  const C8 *c8_Description; 
  
  //! @brief Pointer to parameter unit name
  //! @note Size: 4 byte
  const C8 *c8_Unit; 
  
  //! @brief Parameter universally unique identifier high
  //! @note Size: 8 byte
  U64 u64_PUUID_High;
  
  //! @brief Parameter universally unique identifier low
  //! @note Size: 8 byte
  U64 u64_PUUID_Low;
  
  //! @brief Unique parameter ID
  //! @note Size: 4 byte
  U32 u32_ID; 
  
  //! @brief Parameter data type
  //! @note Size: 4 byte
  TConOpSys_Variant_Data_Type enum_Data_Type; 
  
  //! @brief Parameter access mode
  //! @note Size: 4 byte
  TParameter_Access_Mode enum_Access_Mode; 
 
  //! @brief Parameter limit check mode
  //! @note Size: 4 byte
  TParameter_Boundary_Check_Mode enum_Limit_Check_Mode; 
 
  //! @brief Parameter display format
  //! @note Size: 4 byte
  TParameter_Display_Format enum_Display_Format; 
  
  //! @brief Parameter nonvolatile flag
  //! @note Size: 1 byte
  BOOL bool_Nonvolatile; 
  
  //! @brief Parameter storage type
  //! @note Size: 4 byte
  TParameter_Storage_Type enum_Storage_Type; 
 
  //! @brief Element count
  //! @note Size: 4 byte
  U32 u32_Element_Count;
 
  //! @brief Pointer to the data storage
  //! @note Size: 4 byte
  TConOpSys_Variant_Data *struct_Storage;
 
// Reserved : Dimension_Descriptor
//  TParameter_Dimension_Descriptor *object_Dimension_Descriptor;
 
  //! @brief Minimum value
  //! @note Size: sizeof(TConOpSys_Variant_Data)
  TConOpSys_Variant_Data struct_Minimum_Value; 
  
  //! @brief Maximum value
  //! @note Size: sizeof(TConOpSys_Variant_Data)
  TConOpSys_Variant_Data struct_Maximum_Value; 
  
  //! @brief Default value
  //! @note Size: sizeof(TConOpSys_Variant_Data)
  TConOpSys_Variant_Data struct_Default_Value; 
 
  //! @brief Pointer to extendet parameter description structure
  //! @note Size: 4 byte
  TParameter_Extended_Descriptor_Base *object_Extended_Descriptor;
 
  //! @brief Pointer to parameter data storage structure
  //! @note Size: 4 byte
  TParameter_Base *object_Parameter;
    
} TParameter_Descriptor;
 
//------------------------------------------------------------------------------
 
//! @brief Parameter extern storage frame structure definition
typedef struct
{
  
  //! @brief Parameter index
  U32 u32_ID; 
  
  //! @brief Application ID
  U32 u32_Application_ID; 
  
  //! @brief Variant data storage 
  TConOpSys_Variant_Data struct_Variant_Data; 
 
  //! @brief Checksum
  U32 u32_CRC; 
 
} TParameter_Extern_Storage_Frame;
 
//------------------------------------------------------------------------------
 
//! @brief Parameter properties structure
typedef union
{
  
  U32 u32_Properties; //!< All parameter properties as U32 value
  struct
  {
    U32 u32_Datatype:8; //!< ConOpSys based datatype
    U32 u32_Access_Mode:3; //!< Parameter access mode
    U32 u32_Boundary_Check_Mode:4; //!< Parameter boundary check mode
    U32 u32_Display_Radix:4; //!< Depricated: Parameter display radix
    U32 u32_Display_Format:4; //!< Parameter display flag
    U32 :5; //!< Reserved fields
    U32 u32_Triggerable:1; //!< Parameter triggerable flag
    U32 u32_Nonvolatile:1; //!< Parameter nonvolatile flag
    U32 u32_Autorefresh:1; //!< Parameter autorefresh flag
    U32 u32_Scopeable:1; //!< Parameter scopeability flag
  };
  
} TParameter_Properties;
 
//------------------------------------------------------------------------------
 
//! @brief Parameter satus word
typedef union
{
  
  //! @brief Parameter status raw data
  U32 u32_Status;
  
  //! @brief Parameter status bit parsing structure
  struct
  {
    
    // Bit 0 :
    U32 u32_Incompatible_Type_Assigment:1; 
    
    // Bit 1 :
    U32 u32_Store_To_Media_Request:1;
    
    //    U32 u32_Initialised_From_Media:1; // Bit 2 :
    U32 :1;                                 // Bit 2 :
    
    // Bits 3-4 :
    U32 u32_Initialisation_Status:2;        
    
    // Bit 5 : Unsupported parameter data type
    U32 u32_Unsupported_Data_Type:1;
    
    // Bit 6 : Invalid boundary checking values
    U32 u32_Invalid_Boundary_Checking_Values:1;
    
    // Bit 7 : Invalid default value
    U32 u32_Invalid_Default_Value:1;
    
    // Bits 8-23 : Reserved
    U32 :24;
 
  } Fields;
  
} TParameter_Status;
 
//------------------------------------------------------------------------------
 
//! @brief Remote parameter properties structure
typedef union
{
  
  //! @brief Raw remote parameter properties data as U32 value
  U32 u32_Properties_Raw; 
  
  //! @ Remote parameter properties bit parsing structure
  struct
  {
    
    //! @brief Bits 0-1 : Remote parameter access mode
    U32 bit2_Access_Mode:2; 
      
    //! @brief Bits 2-31 : Reserved
    U32 :30; 
  
  } /*u32_Properties*/;
  
} TRemote_Parameter_Properties;
 
//------------------------------------------------------------------------------
 
//! ANVILEX GG : Rewrite struct => Add node struct witch will include all  
//! parameters for each node, for node to determine node address
//! @brief Remote parameter descriptor
typedef struct
{
  
  //! @brief Pointer to parameter data storage structure
  //! @note Size: 4 byte
  TParameter_Base *object_Local_Parameter;
 
  //! @brief Remote parameter descriptor structure
  struct
  {
 
    //! @brief Remote parameter properties
    //! @note Size: 4 byte
    TRemote_Parameter_Properties struct_Properties;
  
    //! @brief Remote node address
    //! @note Size: 4 byte
    U32 u32_Node_Address; 
 
    //! @brief Nore responce timeout in milisecods.
    U32 u32_Node_Timeout;
    
    //! @brief Remote parameter ID
    //! @note Size: 4 byte
    U32 u32_ID; 
  
    //! @brief Remote parameter elemet index
    //! @note Size: 4 byte
    U32 u32_Element_Index; 
 
  } struct_Remote_Parameter;  
  
} TRemote_Parameter_Mapping_Descriptor;
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------