uied_types.h

Go to the documentation of this file.

/******************************************************************************/
#ifndef uIED_TYPES_H
#define uIED_TYPES_H

#include "ugibso_types.h"

/**********************************************************************************
*    GLOBAL DEFINES
**********************************************************************************/

/**********************************************************************************
*    GLOBAL MACROS
**********************************************************************************/

#define UIED_OCTET_BITS_NUMBER              (8u)                                        
#define UIED_TIME_1984_1_1_IN_UNIXTIME      ((UINT32)441759600uL)                       
#define UIED_TIME_SECONDS_IN_DAY            ((UINT32)(24uL * 60uL * 60uL))              
#define UIED_TIME_MSECONDS_IN_DAY           (UIED_TIME_SECONDS_IN_DAY * 1000uL)         
#define UIED_MAC_LENGTH                     (6)                                         
#define UIED_ETHTYPE_LENGTH                 (sizeof(UINT16))                            
#define UIED_VLAN_LENGTH                    (sizeof(UINT16))                            
#define UIED_APPID_LENGTH                   (sizeof(UINT16))                            
#define UIED_OID_MAX_LENGTH                 (32)                                        
/* Definitions for 32 bit floats */
#define UIED_FLOAT32_PACK_SIZE              (1 + sizeof(FLOAT32))                       
#define UIED_FLOAT32_BITS_NUMBER            (UIED_OCTET_BITS_NUMBER * sizeof(FLOAT32))  
#define UIED_FLOAT32_EXPONENT_BITS_NUMBER   (8)                                         
#define UIED_FLOAT32_EXPONENT_MAXIMUM       (1 << (UIED_FLOAT32_EXPONENT_BITS_NUMBER-1))
#define UIED_FLOAT32_EXPONENT_MINIMUM       (1 - UIED_FLOAT32_EXPONENT_MAXIMUM)         
#define UIED_FLOAT32_EXPONENT_BIASING       (UIED_FLOAT32_EXPONENT_MAXIMUM -1)          
/* Definitions for 64 bit floats */
#define UIED_FLOAT64_PACK_SIZE              (1 + sizeof(FLOAT64))                       
#define UIED_FLOAT64_BITS_NUMBER            (UIED_OCTET_BITS_NUMBER * sizeof(FLOAT64))  
#define UIED_FLOAT64_EXPONENT_BITS_NUMBER   (11)                                        
#define UIED_FLOAT64_EXPONENT_MAXIMUM       (1 << (UIED_FLOAT64_EXPONENT_BITS_NUMBER-1))
#define UIED_FLOAT64_EXPONENT_MINIMUM       (1 - UIED_FLOAT64_EXPONENT_MAXIMUM)         
#define UIED_FLOAT64_EXPONENT_BIASING       (UIED_FLOAT64_EXPONENT_MAXIMUM -1)          
#define UIED_TIME_PACK_SIZE                 (6)                                         
#define UIED_TIME_PACK_SIZE_SHORT           (4)                                         
#define UIED_TIME_MSECONDS_OFFSET           (0)                                         
#define UIED_TIME_MSECONDS_SIZE             (4)                                         
#define UIED_TIME_DAYS_OFFSET               (4)                                         
#define UIED_TIME_DAYS_SIZE                 (2)                                         
#define UIED_TIMESTAMP_PACK_SIZE            (8)                                         
#define UIED_TIMESTAMP_SECONDS_OFFSET       (0)                                         
#define UIED_TIMESTAMP_SECONDS_SIZE         (4)                                         
#define UIED_TIMESTAMP_USECONDS_OFFSET      (4)                                         
#define UIED_TIMESTAMP_USECONDS_SIZE        (3)                                         
#define UIED_TIMESTAMP_FLAGS_OFFSET         (7)                                         
#define UIED_GOOSE_HEADER_SIZE              (8)                                         
/**********************************************************************************
*    GLOBAL DATA TYPES
**********************************************************************************/

/* To reduce the size of the control variables, smaller variables are used if less than 255 nodes required */
#if defined UGIBSO_MAX_NODES_255
    /* Number of nodes limited to max 255 */
    #define UIED_NULL_INDEX                 (UINT8_MAX_VALUE)           
    typedef UINT8   UIED_INDEX;                                         
    typedef UINT16  UIED_DINDEX;                                        
#else
    /* Number of nodes limited to max 65535 */
    #define UIED_NULL_INDEX                 (UINT16_MAX_VALUE)          
    typedef UINT16  UIED_INDEX;                                         
    typedef UINT32  UIED_DINDEX;                                        
#endif

typedef UINT16 UIED_ASN_LENGTH;                                         
typedef UINT8  UIED_ASN_SLENGTH;                                        
typedef UINT16 UIED_ASN_TAG;                                            
typedef enum
{
    UIED_ASN_TAG_CLASS_UNIVERSAL            = 0u,                       
    UIED_ASN_TAG_CLASS_APPLICATION          = 1u,                       
    UIED_ASN_TAG_CLASS_CONTEXT_SPECIFIC     = 2u,                       
    UIED_ASN_TAG_CLASS_PRIVATE              = 3u                        
} UIED_ASN_TAG_CLASS;

typedef enum
{
    UIED_ASN_TYPE_TAG_FAILURE               = 0u,                       
    UIED_ASN_TYPE_TAG_ARRAY                 = 1u,                       
    UIED_ASN_TYPE_TAG_STRUCTURE             = 2u,                       
    UIED_ASN_TYPE_TAG_BOOLEAN               = 3u,                       
    UIED_ASN_TYPE_TAG_BITS                  = 4u,                       
    UIED_ASN_TYPE_TAG_INTEGER               = 5u,                       
    UIED_ASN_TYPE_TAG_UINTEGER              = 6u,                       
    UIED_ASN_TYPE_TAG_FLOAT                 = 7u,                       
    UIED_ASN_TYPE_TAG_OCTETS                = 9u,                       
    UIED_ASN_TYPE_TAG_STRING                = 10u,                      
    UIED_ASN_TYPE_TAG_TIME                  = 12u,                      
    UIED_ASN_TYPE_TAG_UTF8STRING            = 16u,                      
    UIED_ASN_TYPE_TAG_TIMESTAMP             = 17u                       
} UIED_ASN_TYPE_TAG;

typedef enum
{
    UIED_ASN_GOOSE_TAG_SEQUENCE             = 1u,                       
    UIED_ASN_GOOSE_TAG_GOCBREF              = 0u,                       
    UIED_ASN_GOOSE_TAG_TIMEALLOWEDTOLIVE    = 1u,                       
    UIED_ASN_GOOSE_TAG_DATSET               = 2u,                       
    UIED_ASN_GOOSE_TAG_GOID                 = 3u,                       
    UIED_ASN_GOOSE_TAG_T                    = 4u,                       
    UIED_ASN_GOOSE_TAG_STNUM                = 5u,                       
    UIED_ASN_GOOSE_TAG_SQNUM                = 6u,                       
    UIED_ASN_GOOSE_TAG_TEST                 = 7u,                       
    UIED_ASN_GOOSE_TAG_CONFREV              = 8u,                       
    UIED_ASN_GOOSE_TAG_NDSCOM               = 9u,                       
    UIED_ASN_GOOSE_TAG_NUMDATSETENTRIES     = 10u,                      
    UIED_ASN_GOOSE_TAG_ALLDATA              = 11u,                      
    UIED_ASN_GOOSE_TAG_SECURITY             = 12u                       
} UIED_ASN_GOOSE_TAG;

typedef enum
{
    UIED_ETHTYPE_VLAN                       = 0x8100u,                  
    UIED_ETHTYPE_GOOSE                      = 0x88b8u                   
} UIED_ETHTYPE;

typedef struct
{
    UINT32  u32_mSeconds;                                               
    UINT16  u16_Days;                                                   
} UIED_TIME;

typedef struct
{
    UINT32  u32_Seconds;                                                
    UINT32  u32_uSecondsRaw;                                            
    UINT32  u32_uSeconds;                                               
    BOOL8   b8_Leap;                                                    
    BOOL8   b8_Failure;                                                 
    BOOL8   b8_NotSynchronized;                                         
    UINT8   u8_Accuracy;                                                
} UIED_TIMESTAMP;

typedef struct
{
    UINT8   u8_Octets[UIED_MAC_LENGTH];                                 
} UIED_MAC;

typedef struct
{
    UINT8   u8_Length;                                                  
    UINT32  u32_Ids[UIED_OID_MAX_LENGTH];                               
} UIED_OID;

typedef enum
{
    UIED_NODE_TYPE_NONE,                                                
    UIED_NODE_TYPE_LD,                                                  
    UIED_NODE_TYPE_DS,                                                  
    UIED_NODE_TYPE_REFERENCE,                                           
    UIED_NODE_TYPE_LN,                                                  
    UIED_NODE_TYPE_FC,                                                  
    UIED_NODE_TYPE_DO,                                                  
    UIED_NODE_TYPE_DA,                                                  
    UIED_NODE_TYPE_ARRAY,                                               
    UIED_NODE_TYPE_BOOLEAN,                                             
    UIED_NODE_TYPE_BITS,                                                
    UIED_NODE_TYPE_INTEGER8,                                            
    UIED_NODE_TYPE_INTEGER16,                                           
    UIED_NODE_TYPE_INTEGER32,                                           
    UIED_NODE_TYPE_INTEGER64,                                           
    UIED_NODE_TYPE_UINTEGER8,                                           
    UIED_NODE_TYPE_UINTEGER16,                                          
    UIED_NODE_TYPE_UINTEGER32,                                          
    UIED_NODE_TYPE_UINTEGER64,                                          
    UIED_NODE_TYPE_FLOAT32,                                             
    UIED_NODE_TYPE_FLOAT64,                                             
    UIED_NODE_TYPE_OCTETS,                                              
    UIED_NODE_TYPE_STRING,                                              
    UIED_NODE_TYPE_TIME,                                                
    UIED_NODE_TYPE_UTF8STRING,                                          
    UIED_NODE_TYPE_TIMESTAMP                                            
} UIED_NODE_TYPE;

typedef struct
{
    UIED_NODE_TYPE  e_Type;                                             
    BOOL8           b8_Config;                                          
    BOOL8           b8_Writable;                                        
    BOOL8           b8_Protected;                                       
    CHAR*           cp_Name;                                            
    SINT16          s16_Length;                                         
    UIED_INDEX      idx_ValueIndex;                                     
    UIED_INDEX      idx_ParentIndex;                                    
    UIED_INDEX      idx_NextIndex;                                      
    UIED_INDEX      idx_ChildIndex;                                     
} UIED_NODE;

typedef struct
{
    CHAR*           cp_Reference;                                       
    UIED_INDEX      idx_NodeIndex;                                      
} UIED_REFERENCE;


typedef struct
{
    CHAR*           cp_Name;                                            
    UIED_INDEX      idx_LogicalDeviceIndex;                             
    UIED_INDEX      idx_FirstReference;                                 
    UIED_INDEX      idx_ReferencesNumber;                               
} UIED_DATASET;

typedef struct
{
    UIED_INDEX      idx_NodeIndex;                                      
    BOOL8           b8_Simulated;                                       
    UINT32          u32_TimeAllowedToLive;                              
    UIED_INDEX      idx_DatasetIndex;                                   
    UIED_TIMESTAMP  st_T;                                               
    UINT32          u32_StNum;                                          
    UINT32          u32_SqNum;                                          
    BOOL8           b8_Test;                                            
} UIED_GOOSE;

typedef enum
{
    UIED_RESULT_OK               = 0u,                                  
    UIED_RESULT_ERROR_BAD_INDEX  = 1u,                                  
    UIED_RESULT_ERROR_BAD_LENGTH = 2u,                                  
    UIED_RESULT_ERROR_BAD_TAG    = 3u,                                  
    UIED_RESULT_ERROR_BAD_TYPE   = 4u,                                  
    UIED_RESULT_ERROR_BAD_VALUE  = 5u,                                  
    UIED_RESULT_ERROR_NO_MEMORY  = 6u,                                  
    UIED_RESULT_ERROR_UNDER_SIZE = 7u                                   
} UIED_RESULT;

#endif /* uIED_TYPES_H */