CCAuxTypes.h

Go to the documentation of this file.

/*
 *  File description: Common types
 *
 ************************************************/
 
#ifndef CCAUXTYPES_H_
#define CCAUXTYPES_H_
 
// CCAux API uses default integer types based on stdint.h with addition of float, double and character types.
// stdint.h is not available on all platforms/systems (e.g. Visual Studio for Windows).
// Define CCAUX_USE_STDINT_H to use the stdint.h from your build system instead of these defaults.
// Define CCAUX_USER_TYPEDEFS to use your own header file entirely.
#ifdef CCAUX_USE_STDINT_H
#include <stdint.h>
typedef float float32_t;
typedef double float64_t;
typedef char char_t;
#else
// You can also include your own typedef file.
#ifdef CCAUX_USER_TYPEDEFS
// This file is not part of CCAux, you must provide it yourself.
#include <ccaux_ext_typedefs.h>
#else
 
// CCAux default typdefs
typedef float float32_t;
typedef double float64_t;
typedef char char_t;
 
#ifdef _MSC_VER
// Microsoft Visual Studio
#if (_MSC_VER < 1300)
// Visual Studio 6 and Embedded Visual C++ 4
typedef signed char int8_t;
typedef signed short int16_t;
typedef signed int int32_t;
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
typedef unsigned int uint32_t;
#else
// VS2003+
typedef signed __int8 int8_t;
typedef signed __int16 int16_t;
typedef signed __int32 int32_t;
typedef unsigned __int8 uint8_t;
typedef unsigned __int16 uint16_t;
typedef unsigned __int32 uint32_t;
#endif
typedef signed __int64 int64_t;
typedef unsigned __int64 uint64_t;
 
#else // _MSC_VER
// Other compilers (e.g gcc)
typedef signed char int8_t;
typedef signed short int16_t;
typedef signed int int32_t;
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
typedef unsigned int uint32_t;
#ifdef X64
typedef long int int64_t;
typedef unsigned long int uint64_t;
#else
// typedef long long int     int64_t;
// typedef unsigned long long int  uint64_t;
#endif
 
#endif // _MSC_VER
#endif // CCAUX_USER_TYPEDEFS
#endif // CCAUX_USE_STDINT
 
#include "version_string.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
#ifndef __cplusplus
#define bool int
#endif
 
typedef enum
{
    VOLTAGE_24VIN = 0,     
    VOLTAGE_24V,           
    VOLTAGE_12V,           
    VOLTAGE_12VID,         
    VOLTAGE_5V,            
    VOLTAGE_3V3,           
    VOLTAGE_VTFT,          
    VOLTAGE_5VSTB,         
    VOLTAGE_1V9,           
    VOLTAGE_1V8,           
    VOLTAGE_1V5,           
    VOLTAGE_1V2,           
    VOLTAGE_1V05,          
    VOLTAGE_1V0,           
    VOLTAGE_0V9,           
    VOLTAGE_VREF_INT,      
    VOLTAGE_24V_BACKUP,    
    VOLTAGE_2V5,           
    VOLTAGE_1V1,           
    VOLTAGE_1V3_PER,       
    VOLTAGE_1V3_VDDA,      
    VOLTAGE_3V3STBY,       
    VOLTAGE_VPMIC,         
    VOLTAGE_VMAIN,         
    VOLTAGE_UB,            
    VOLTAGE_AI_1,          
    VOLTAGE_AI_2,          
    VOLTAGE_AI_3,          
    VOLTAGE_5V_MP,         
    VOLTAGE_12V_BL,        
    VOLTAGE_VHEAT,         
    VOLTAGE_VIN_FILT,      
    VOLTAGE_VIN_PROT,      
    VOLTAGE_BL_ANODE,      
    VOLTAGE_IGN_STATE,     
    VOLTAGE_IGN_VALUE,     
    VOLTAGE_PRE_IGN_STATE, 
    VOLTAGE_PRE_IGN_VALUE, 
    VOLTAGE_VBACKUP,       
    VOLTAGE_END            
} VoltageEnum;
 
typedef enum
{
    RangeStandard = 0, 
    RangeExtended = 1, 
    RangeAuto     = 2, 
    Range16K      = 3, 
    Range64K      = 4  
} LightSensorOperationRange;
 
typedef enum
{
    SamplingModeStandard = 0, 
    SamplingModeExtended,     
    SamplingModeAuto          
} LightSensorSamplingMode;
 
typedef enum
{
    Disabled = 0, 
    Enabled  = 1  
} CCStatus;
 
typedef enum
{
    ERR_SUCCESS                       = 0,  
    ERR_OPEN_FAILED                   = 1,  
    ERR_NOT_SUPPORTED                 = 2,  
    ERR_UNKNOWN_FEATURE               = 3,  
    ERR_DATATYPE_MISMATCH             = 4,  
    ERR_CODE_NOT_EXIST                = 5,  
    ERR_BUFFER_SIZE                   = 6,  
    ERR_IOCTRL_FAILED                 = 7,  
    ERR_INVALID_DATA                  = 8,  
    ERR_INVALID_PARAMETER             = 9,  
    ERR_CREATE_THREAD                 = 10, 
    ERR_IN_PROGRESS                   = 11, 
    ERR_CHECKSUM                      = 12, 
    ERR_INIT_FAILED                   = 13, 
    ERR_VERIFY_FAILED                 = 14, 
    ERR_DEVICE_READ_DATA_FAILED       = 15, 
    ERR_DEVICE_WRITE_DATA_FAILED      = 16, 
    ERR_COMMAND_FAILED                = 17, 
    ERR_EEPROM                        = 18, 
    ERR_JIDA_TEMP                     = 19, 
    ERR_AVERAGE_CALC_STARTED          = 20, 
    ERR_NOT_RUNNING                   = 21, 
    ERR_I2C_EXPANDER_READ_FAILED      = 22, 
    ERR_I2C_EXPANDER_WRITE_FAILED     = 23, 
    ERR_I2C_EXPANDER_INIT_FAILED      = 24, 
    ERR_NEWER_SS_VERSION_REQUIRED     = 25, 
    ERR_NEWER_FPGA_VERSION_REQUIRED   = 26, 
    ERR_NEWER_FRONT_VERSION_REQUIRED  = 27, 
    ERR_TELEMATICS_GPRS_NOT_AVAILABLE = 28, 
    ERR_TELEMATICS_WLAN_NOT_AVAILABLE = 29, 
    ERR_TELEMATICS_BT_NOT_AVAILABLE   = 30, 
    ERR_TELEMATICS_GPS_NOT_AVAILABLE  = 31, 
    ERR_MEM_ALLOC_FAIL                = 32, 
    ERR_JOIN_THREAD                   = 33, 
    ERR_INVALID_STARTUP_TRIGGER       = 34, 
    ERR_UNSUPPORTED_CONFIGURATION     = 35, 
    ERR_HARDWARE_PROBE                = 36, 
    ERR_END                           
} eErr;
 
typedef enum
{
    DeInterlace_Even = 0, 
    DeInterlace_Odd  = 1, 
    DeInterlace_BOB  = 2  
} DeInterlaceMode;
 
typedef enum
{
    Analog_Channel_1 = 0, 
    Analog_Channel_2 = 1, 
    Analog_Channel_3 = 2, 
    Analog_Channel_4 = 3, 
    Analog_channel_END    
} VideoChannel;
 
/* Struct used for received video */
struct received_video
{
    uint16_t received_width;
    uint16_t received_height;
    uint8_t received_framerate;
};
 
/* Struct used for I2c-accesses to decoder */
struct video_dec_command
{
    uint8_t decoder_register;
    uint8_t register_value;
};
 
/* Version info struct */
struct version_info
{
    uint8_t major;   
    uint8_t minor;   
    uint8_t release; 
    uint8_t build;   
};
 
/* Version string */
struct version_string
{
    uint32_t len;                                                                   
    char data[2U * (INFO_ID_SS_VERSTRING_LAST - INFO_ID_SS_VERSTRING_BASE + 1U)];   
};
 
/* Video standard */
/* The video decoder auto detect the video standard */
typedef enum
{
    STD_M_J_NTSC        = 0, 
    STD_B_D_G_H_I_N_PAL = 1, 
    STD_M_PAL           = 2, 
    STD_PAL             = 3, 
    STD_NTSC            = 4, 
    STD_SECAM           = 5  
} videoStandard;
 
/* Available video rotation */
typedef enum
{
    RotNone = 0, 
    Rot90,       
    Rot180,      
    Rot270       
} VideoRotation;
 
typedef struct version_info VersionType;
 
/* Buzzer setup struct */
typedef struct
{
    uint16_t frequency; 
    uint16_t volume;    
} BuzzerSetup;
 
/* Led timing setup struct */
typedef struct
{
    uint8_t onTime;     
    uint8_t offTime;    
    uint8_t idleTime;   
    uint8_t nrOfPulses; 
} LedTimingType;
 
/* For FPGA leds */
typedef struct
{
    uint8_t ledNbr;     
    uint8_t onTime;     
    uint8_t offTime;    
    uint8_t idleTime;   
    uint8_t nrOfPulses; 
} FpgaLedTimingType;
 
/* Led color struct */
typedef struct
{
    uint8_t red;   
    uint8_t green; 
    uint8_t blue;  
} LedColorMixType;
 
typedef enum
{
    FrameStandard, 
    FrameExtended, 
    FrameStandardExtended 
} CanFrameType;
 
typedef enum
{
    CanModeClassic, 
    CanModeFlexibleData 
} CanMode;
 
typedef enum
{
    Trigger_OnOff_Button        = 0, 
    Trigger_Ignition_Signal     = 2, 
    Trigger_Pre_Ignition_Signal = 3, 
    Trigger_IO_MCU_1            = 4, 
    Trigger_IO_MCU_2            = 5, 
    Trigger_IO_MCU_3            = 6, 
    Trigger_IO_MCU_4            = 7, 
    Trigger_CAN_WU              = 8, 
    Trigger_Ethernet            = 9, 
    Last_trigger_type
} TriggerType;
 
typedef enum
{
    Front_Button_Enabled           = 1,  
    OnOff_Signal_Enabled           = 2,  
    Both_Button_And_Signal_Enabled = 3,  
    CAN_Button_Activity            = 5,  
    CAN_OnOff_Activity             = 6,  
    CAN_Button_OnOff_Activity      = 7,  
    CI_Button_Activity             = 9,  
    CI_OnOff_Activity              = 10, 
    CI_Button_OnOff_Activity       = 11, 
    CI_CAN_Button_Activity         = 13, 
    CI_CAN_OnOff_Activity          = 14, 
    All_Events                     = 15, 
    Last_trigger_conf                    
} TriggerConf;
 
typedef enum
{
    Startup_OnOff_Button       = 0,  
    Startup_Reserved           = 1,  
    Startup_Ignition_Signal    = 2,  
    Startup_Preignition_Signal = 3,  
    Startup_IO_MCU1            = 4,  
    Startup_IO_MCU2            = 5,  
    Startup_IO_MCU3            = 6,  
    Startup_IO_MCU4            = 7,  
    Startup_CAN_WU_pattern     = 8,  
    Startup_Ethernet           = 9,  
    Startup_Start_On_PowerOn   = 10, 
    Startup_Last_cfg                 
} StartupTriggerCfg;
 
typedef enum
{
    Wakeup_OnOff_Button       = 0,   
    Wakeup_Reserved           = 1,   
    Wakeup_Ignition_Signal    = 2,   
    Wakeup_Preignition_Signal = 3,   
    Wakeup_IO_MCU1            = 4,   
    Wakeup_IO_MCU2            = 5,   
    Wakeup_IO_MCU3            = 6,   
    Wakeup_IO_MCU4            = 7,   
    Wakeup_CAN_WU_pattern     = 8,   
    Wakeup_Ethernet           = 9,   
    Wakeup_CAN_WU             = 10,  
    Wakeup_RS232              = 11,  
    Wakeup_Last_cfg                  
} WakeupTriggerCfg;
 
typedef enum
{
    Action_Button_Short_Press = 0,  
    Action_Button_Long_Press  = 1,  
    Action_Ignition_Signal    = 2,  
    Action_Preignition_Signal = 3,  
    Action_IO_MCU1            = 4,  
    Action_IO_MCU2            = 5,  
    Action_IO_MCU3            = 6,  
    Action_IO_MCU4            = 7,  
    Last_action_conf                
} ActionTriggerCfg;
 
typedef enum
{
    NoAction       = 0, 
    ActionSuspend  = 1, 
    ActionShutDown = 2  
} PowerAction;
 
typedef enum
{
    BPTS_No_Change = 0, 
    BPTS_ShutDown  = 1, 
    BPTS_Suspend = 2,   
    BPTS_Restart    = 3, 
    BPTS_BtnPressed = 4, 
    BPTS_BtnPressedLong = 5, 
    BPTS_SignalOff =
        6,   
    BPTS_END 
} ButtonPowerTransitionStatus;
 
typedef enum
{
    OCD_OK = 0, 
    OCD_OC = 1, 
    OCD_POWER_OFF = 2 
} OCDStatus;
 
typedef struct
{
    uint32_t TotRunTime;     
    uint32_t TotSuspTime;    
    uint32_t TotHeatTime;    
    uint32_t RunTime40_60;   
    uint32_t RunTime60_70;   
    uint32_t RunTime70_80;   
    uint32_t Above80RunTime; 
} TimerType;
 
typedef struct
{
    uint32_t TotRunTime;      
    uint32_t TotSuspTime;     
    uint32_t TotHeatTime;     
    uint32_t RunTime40_60;    
    uint32_t RunTime60_70;    
    uint32_t RunTime70_80;    
    uint32_t RunTime80_90;    
    uint32_t RunTime90_100;   
    uint32_t Above100RunTime; 
} TimerTypeExt;
 
typedef enum
{
    TEMP_CPU       = 0, 
    TEMP_BOX       = 1, 
    TEMP_ENV       = 2, 
    TEMP_BOARD     = 3, 
    TEMP_BACKPLANE = 4, 
    TEMP_CHIPSETS  = 5, 
    TEMP_VIDEO     = 6, 
    TEMP_OTHER     = 7  
} JidaSensorType;
 
enum UpgradeAction
{
    UPGRADE_INIT,                
    UPGRADE_PREP_COM,            
    UPGRADE_READING_FILE,        
    UPGRADE_CONVERTING_FILE,     
    UPGRADE_FLASHING,            
    UPGRADE_VERIFYING,           
    UPGRADE_COMPLETE,            
    UPGRADE_COMPLETE_WITH_ERRORS 
};
 
typedef struct
{
    enum UpgradeAction currentAction; 
    uint8_t percent;                  
    eErr errorCode;                   
} UpgradeStatus;
 
typedef enum
{
    RED = 0,        
    GREEN,          
    BLUE,           
    CYAN,           
    MAGENTA,        
    YELLOW,         
    UNDEFINED_COLOR 
} CCAuxColor;
 
typedef enum
{
    LOC_BASE      = 0, 
    LOC_DISPLAY_1 = 1, 
    LOC_DISPLAY_2 = 2, 
    LOC_UNDEFINED = 3  
} ComponentLocation;
 
typedef enum
{
    RS4XXPort1 = 1, 
    RS4XXPort2,     
    RS4XXPort3,     
    RS4XXPort4      
} RS4XXPort;
 
typedef enum
{
    CFGIN_NOT_IN_USE = 0, 
    CFGIN_RESERVED_1,     
    CFGIN_RESERVED_2,     
    CFGIN_RESERVED_3,     
    CFGIN_VOLTAGE_5V,     
    CFGIN_RESISTANCE,     
    CFGIN_RESERVED_6,     
    CFGIN_RESERVED_7,     
    CFGIN_RESERVED_8,     
    CFGIN_RESERVED_9,     
    CFGIN_CURRENT_4_20,   
    CFGIN_RESERVED_11,    
    CFGIN_VOLTAGE_32V,    
    CFGIN_DIGITAL_PD_5V,  
    CFGIN_RESERVED_14,    
    CFGIN_RESERVED_15,    
    CFGIN_DIGITAL_F_5V,   
    CFGIN_RESERVED_17,    
    CFGIN_RESERVED_18,    
    CFGIN_DIGITAL_PU_5V,  
    CFGIN_RESERVED_20,    
    CFGIN_RESERVED_21,    
    CFGIN_FREQ_PD_5V,     
    CFGIN_RESERVED_23,    
    CFGIN_RESERVED_24,    
    CFGIN_FREQ_F_5V,      
    CFGIN_RESERVED_26,    
    CFGIN_RESERVED_27,    
    CFGIN_FREQ_PU_5V,     
    CFGIN_RESERVED_29,    
    CFGIN_RESERVED_30,    
    CFGIN_DC_PD_5V,       
    CFGIN_RESERVED_32,    
    CFGIN_RESERVED_33,    
    CFGIN_DC_F_5V,        
    CFGIN_RESERVED_35,    
    CFGIN_RESERVED_36,    
    CFGIN_DC_PU_5V,       
    CFGIN_MAX             
} CfgInModeEnum;
 
typedef enum
{
    IOMCU_0 = 0x0,
    IOMCU_1 = 0x1,
    IOMCU_2 = 0x2,
    IOMCU_3 = 0x3
} IOMCUlocation;
 
typedef enum
{
    BUTTON_ONLY_MP_ACTION = 0x00,  
    BUTTON_AS_STARTUP_TRIG = 0x02, 
    BUTTON_AS_ACTION_TRIG  = 0x04, 
    BUTTON_AS_ACTION_STARTUP_TRIG =
        0x06, 
    BUTTON_AS_BACKLIGHT_DECREASE          = 0x08, 
    BUTTON_AS_BACKLIGHT_DECR_STARTUP_TRIG = 0x0A, 
    BUTTON_AS_BACKLIGHT_INCREASE          = 0x0C, 
    BUTTON_AS_BACKLIGHT_INCR_STARTUP_TRIG =
        0x0E 
} ButtonConfigEnum;
 
typedef enum
{
    BOOTMODE_EMMC = 0,      
    BOOTMODE_SD,            
    BOOTMODE_SERIAL,        
    BOOTMODE_RESCUE,        
    BOOTMODE_RESCUE_SPECIAL 
} BootModeEnum;
 
typedef enum
{
    CONFIG_ONOFF_EDGE_TRIGGER = 0, 
    CONFIG_ONOFF_LEVEL_TRIGGER     
} ConfigOnOffTriggerMode;
 
typedef enum
{
    PowerOutput1 = 0, 
    PowerOutput2,     
    PowerOutput3,     
    PowerOutput4,     
    PowerOutput5,     
    PowerOutput6,     
    PowerOutputMax    
} PowerOutput;
 
typedef enum
{
    SYSTEMMODE_Startup                   = 0, 
    SYSTEMMODE_StartupRescue             = 1, 
    SYSTEMMODE_StartupRescueFactoryReset = 2, 
    SYSTEMMODE_NormalRunning             = 3, 
    SYSTEMMODE_RescueRunning             = 4, 
    SYSTEMMODE_RescueRunningFactoryReset = 5, 
    SYSTEMMODE_Unknown                   = 6  
} SystemMode;
 
#ifdef __cplusplus
}
#endif
 
#endif /*CCAUXTYPES_H_*/