clAlarmDefinitions.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : alarm
 * File        : clAlarmDefinitions.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * This file has alarm related definitions
 *
 *
 *****************************************************************************/

#ifndef _CL_ALARM_DEFINITIONS_H_
#define _CL_ALARM_DEFINITIONS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>
#include <clVersion.h>
#include <clCorMetaData.h>

/****************************************************************************
 * Type/Constant definitions
 ****************************************************************************/

/****************************************************************************
 * Categories of Alarm
 ****************************************************************************/
#define ClAlarmEventName "CL_ALARM_EVENT_CHANNEL"

#define CL_ALARM_EVENT 1

typedef enum{

     CL_ALARM_CATEGORY_INVALID             = 0,

     CL_ALARM_CATEGORY_COMMUNICATIONS       = 1,

     CL_ALARM_CATEGORY_QUALITY_OF_SERVICE   = 2,

     CL_ALARM_CATEGORY_PROCESSING_ERROR     = 3,

     CL_ALARM_CATEGORY_EQUIPMENT            = 4,

     CL_ALARM_CATEGORY_ENVIRONMENTAL        = 5,


}ClAlarmCategoryTypeT;

/****************************************************************************
 * Specific problem of Alarm
 ****************************************************************************/

typedef ClUint32T ClAlarmSpecificProblemT;

typedef ClUint32T ClAlarmHandleT;

/****************************************************************************
 * Severities of Alarm
 ****************************************************************************/

typedef enum{

     CL_ALARM_SEVERITY_INVALID       = 0,

     CL_ALARM_SEVERITY_CRITICAL      = 1,

     CL_ALARM_SEVERITY_MAJOR         = 2,

     CL_ALARM_SEVERITY_MINOR         = 3,

     CL_ALARM_SEVERITY_WARNING       = 4,

     CL_ALARM_SEVERITY_INDETERMINATE = 5,

     CL_ALARM_SEVERITY_CLEAR         = 6

}ClAlarmSeverityTypeT;

/****************************************************************************
 * List of probable cause of alarms.
 ****************************************************************************/

typedef enum{
    CL_ALARM_ID_INVALID =0,
    CL_ALARM_PROB_CAUSE_LOSS_OF_SIGNAL = 1,

    CL_ALARM_PROB_CAUSE_LOSS_OF_FRAME,

    CL_ALARM_PROB_CAUSE_FRAMING_ERROR,

    CL_ALARM_PROB_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR,

    CL_ALARM_PROB_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR,

    CL_ALARM_PROB_CAUSE_CALL_ESTABLISHMENT_ERROR,

    CL_ALARM_PROB_CAUSE_DEGRADED_SIGNAL,

    CL_ALARM_PROB_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE,

    CL_ALARM_PROB_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR,

    CL_ALARM_PROB_CAUSE_LAN_ERROR,

    CL_ALARM_PROB_CAUSE_DTE,

    CL_ALARM_PROB_CAUSE_RESPONSE_TIME_EXCESSIVE,

    CL_ALARM_PROB_CAUSE_QUEUE_SIZE_EXCEEDED,

    CL_ALARM_PROB_CAUSE_BANDWIDTH_REDUCED,

    CL_ALARM_PROB_CAUSE_RETRANSMISSION_RATE_EXCESSIVE,

    CL_ALARM_PROB_CAUSE_THRESHOLD_CROSSED,

    CL_ALARM_PROB_CAUSE_PERFORMANCE_DEGRADED,

    CL_ALARM_PROB_CAUSE_CONGESTION,

    CL_ALARM_PROB_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY,

    CL_ALARM_PROB_CAUSE_STORAGE_CAPACITY_PROBLEM,

    CL_ALARM_PROB_CAUSE_VERSION_MISMATCH,

    CL_ALARM_PROB_CAUSE_CORRUPT_DATA,

    CL_ALARM_PROB_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED,

    CL_ALARM_PROB_CAUSE_SOFWARE_ERROR,

    CL_ALARM_PROB_CAUSE_SOFTWARE_PROGRAM_ERROR,

    CL_ALARM_PROB_CAUSE_SOFWARE_PROGRAM_ABNORMALLY_TERMINATED,

    CL_ALARM_PROB_CAUSE_FILE_ERROR,

    CL_ALARM_PROB_CAUSE_OUT_OF_MEMORY,

    CL_ALARM_PROB_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE,

    CL_ALARM_PROB_CAUSE_APPLICATION_SUBSYSTEM_FAILURE,

    CL_ALARM_PROB_CAUSE_CONFIGURATION_OR_CUSTOMIZATION_ERROR,

    CL_ALARM_PROB_CAUSE_POWER_PROBLEM,
    
    CL_ALARM_PROB_CAUSE_TIMING_PROBLEM,
    
    CL_ALARM_PROB_CAUSE_PROCESSOR_PROBLEM,
    
    CL_ALARM_PROB_CAUSE_DATASET_OR_MODEM_ERROR,
    
    CL_ALARM_PROB_CAUSE_MULTIPLEXER_PROBLEM,
    
    CL_ALARM_PROB_CAUSE_RECEIVER_FAILURE,
    
    CL_ALARM_PROB_CAUSE_TRANSMITTER_FAILURE,
    
    CL_ALARM_PROB_CAUSE_RECEIVE_FAILURE,
    
    CL_ALARM_PROB_CAUSE_TRANSMIT_FAILURE,
    
    CL_ALARM_PROB_CAUSE_OUTPUT_DEVICE_ERROR,
    
    CL_ALARM_PROB_CAUSE_INPUT_DEVICE_ERROR,
    
    CL_ALARM_PROB_CAUSE_INPUT_OUTPUT_DEVICE_ERROR,
    
    CL_ALARM_PROB_CAUSE_EQUIPMENT_MALFUNCTION,
    
    CL_ALARM_PROB_CAUSE_ADAPTER_ERROR,

    CL_ALARM_PROB_CAUSE_TEMPERATURE_UNACCEPTABLE,

    CL_ALARM_PROB_CAUSE_HUMIDITY_UNACCEPTABLE,

    CL_ALARM_PROB_CAUSE_HEATING_OR_VENTILATION_OR_COOLING_SYSTEM_PROBLEM,

    CL_ALARM_PROB_CAUSE_FIRE_DETECTED,

    CL_ALARM_PROB_CAUSE_FLOOD_DETECTED,

    CL_ALARM_PROB_CAUSE_TOXIC_LEAK_DETECTED,

    CL_ALARM_PROB_CAUSE_LEAK_DETECTED,

    CL_ALARM_PROB_CAUSE_PRESSURE_UNACCEPTABLE,

    CL_ALARM_PROB_CAUSE_EXCESSIVE_VIBRATION,

    CL_ALARM_PROB_CAUSE_MATERIAL_SUPPLY_EXHAUSTED,

    CL_ALARM_PROB_CAUSE_PUMP_FAILURE,

    CL_ALARM_PROB_CAUSE_ENCLOSURE_DOOR_OPEN
}ClAlarmProbableCauseT;


typedef enum{
    CL_ALARM_STATE_INVALID = -1,
    CL_ALARM_STATE_CLEAR   =   0,
    CL_ALARM_STATE_ASSERT  =   1,
    CL_ALARM_STATE_SUPPRESSED = 2,
    CL_ALARM_STATE_UNDER_SOAKING = 3

}ClAlarmStateT;

typedef struct
{
    ClAlarmProbableCauseT probCause;

    ClNameT compName;

    ClCorMOIdT moId;

    ClAlarmStateT alarmState;

    ClAlarmCategoryTypeT category;

    ClAlarmSpecificProblemT specificProblem;

    ClAlarmSeverityTypeT severity;

    ClTimeT    eventTime;

    ClUint32T len;

    ClUint8T buff[1];

}ClAlarmInfoT;

typedef ClAlarmInfoT* ClAlarmInfoPtrT;

typedef struct 
{
    ClAlarmHandleT alarmHandle;
    ClAlarmInfoT   alarmInfo;
}ClAlarmHandleInfoT;


typedef enum
{
    CL_ALARM_REPORT = 0,

    CL_ALARM_POLL
}ClAlarmFetchModeT;

typedef enum
{
    CL_ALARM_RULE_NO_RELATION =0,
    CL_ALARM_RULE_LOGICAL_OR,
    CL_ALARM_RULE_LOGICAL_AND,
    CL_ALARM_RULE_RELATION_INVALID,
}ClAlarmRuleRelationT;


typedef struct {
    ClAlarmProbableCauseT   probableCause;

    ClAlarmSpecificProblemT specificProblem;
}ClAlarmRuleEntryT;

typedef ClAlarmRuleEntryT VDECL_VER(ClAlarmIdT, 4, 1, 0);

typedef struct
{
    ClAlarmRuleRelationT relation;

    ClAlarmRuleEntryT* alarmIds;
}ClAlarmRuleInfoT;


typedef struct ClAlarmProfile
{

     ClAlarmCategoryTypeT category;

    ClAlarmProbableCauseT probCause;

     ClAlarmSeverityTypeT severity;

    ClAlarmFetchModeT fetchMode;

    ClUint32T assertSoakingTime;

    ClUint32T clearSoakingTime;

    ClAlarmRuleInfoT* generationRule;

    ClAlarmRuleInfoT* suppressionRule;

    ClAlarmSpecificProblemT  specificProblem;
}ClAlarmProfileT;

typedef struct ClAlarmComponentResAlarms
{

    ClCorClassTypeT moClassID;

    ClUint32T pollingTime;

    ClAlarmProfileT* MoAlarms;
}ClAlarmComponentResAlarmsT;

typedef struct ClAlarmPendingAlmInfo
{
    ClAlarmHandleT alarmHandle;

    ClAlarmInfoPtrT pAlarmInfo;
}ClAlarmPendingAlmInfoT;

typedef ClAlarmPendingAlmInfoT* ClAlarmPendingAlmInfoPtrT;

typedef struct ClAlarmPendingAlmList
{
    ClUint32T       noOfPendingAlarm;

    ClAlarmPendingAlmInfoPtrT  pAlarmList;
}ClAlarmPendingAlmListT;

typedef ClAlarmPendingAlmListT* ClAlarmPendingAlmListPtrT;

#ifdef __cplusplus
}
#endif

#endif /* _CL_ALARM_DEFINITIONS_H_ */