clCmApi.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  : cm
 * File        : clCmApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 * Header File for Chassis Manager 
 *
 *
 *****************************************************************************/

#ifndef _CLCMAPI_H_ 
#define _CLCMAPI_H_

#ifdef __cplusplus
extern "C" { 
#endif 

    /* If the flag is not defined this will define no-ops for all APIs that is enough to satisfy the compiler */
#ifndef CL_USE_CHASSIS_MANAGER
    
#include <clCommon.h>
#include <clCommonErrors.h>
#include <clCorMetaData.h>

    /* the EO automatically generates a call to this to initalize the CM library, so give it a NULL pointer if CM is off */    
#define clCmLibInitialize 0
#define clCmLibFinalize 0
    
#define CL_CM_VERSION {(ClUint8T)'B', 0x1, 0x1}


/* Please note that the event publishing service by CM is currently
 * disabled, hence they are not doxygen-visible comments
 */
 
/*  
 *  Chassis Manager Event Channel on which events will be published.
 */
#define CL_CM_EVENT_CHANNEL "CM_EVENT_CHANNEL"


/* The following are the events published by Chassis Manager. */ 

/*
 * Event issued after hot-swapping of an FRU is done.
 */
#define CL_CM_FRU_STATE_TRANSITION_EVENT_STR "cmFruStateTranstionEvent"

/*
 *  Payload of the FRU Event being published on the FRU state transition.
 */
typedef struct ClCmFruEventInfo {

/*
 *  Id of the FRU in the physical slot.
 */ 
         ClUint32T         fruId;
                                
/*
 *  Physical slot of the FRU. Before using, always perform a check for the slot id against \c INVALID_PHYSICAL_SLOT_ID.
 */                                                                                
         ClInt32T          physicalSlot;

#if 0  /* Note HPI is NOT being used so these structures are just fake placeholders */
    /*
 * Previous state of the FRU.
 */                                                                                
         SaHpiHsStateT previousState; 

/*
 * Present state of the FRU.
 */      
         SaHpiHsStateT presentState;
#endif    
} ClCmFruEventInfoT;

/*
 * Contents of buffer field in alarmPayload for sensor event payload.
 */
typedef struct ClCmSensorEventInfo {
#if 0  /* Note HPI is NOT being used so these structures are just fake placeholders */    
    SaHpiRptEntryT      rptEntry;
    SaHpiRdrT           rdr;
    SaHpiSensorEventT   sensorEvent;
#else
    int fake;
#endif    
} ClCmSensorEventInfoT;


typedef struct {
#if 0  /* Note HPI is NOT being used so these structures are just fake placeholders */    
    SaHpiEntityPathT eventReporter;
    SaHpiEntityPathT *pImpactedEntities;
#else
    int fake;
#endif    
} ClCmEventCorrelatorT;

#if 0    
typedef ClRcT (* ClCmEventCallBackT) (SaHpiSessionIdT sessionid , 
                                      SaHpiEventT *pEvent , 
                                      SaHpiRptEntryT  *pRptEntry, 
                                      SaHpiRdrT *pRdr);
#else
 typedef ClRcT (* ClCmEventCallBackT) (unsigned int sessionid , 
                                      void *pEvent , 
                                      void  *pRptEntry, 
                                      void *pRdr);   
#endif    
    
typedef struct {
#if 0  /* Note HPI is NOT being used so these structures are just fake placeholders */    
    SaHpiEntityPathT impactedEntity;
#endif    
    ClCmEventCallBackT userEventHandler;
} ClCmUserPolicyT;

#if 0    
typedef enum ClCmThresholdLevel
{
    
    CL_CM_THRESHOLD_LOWER_MINOR = SAHPI_ES_LOWER_MINOR,
    CL_CM_THRESHOLD_LOWER_MAJOR = SAHPI_ES_LOWER_MAJOR,
    CL_CM_THRESHOLD_LOWER_CRIT  = SAHPI_ES_LOWER_CRIT,
    CL_CM_THRESHOLD_UPPER_MINOR = SAHPI_ES_UPPER_MINOR,
    CL_CM_THRESHOLD_UPPER_MAJOR = SAHPI_ES_UPPER_MAJOR,
    CL_CM_THRESHOLD_UPPER_CRIT =  SAHPI_ES_UPPER_CRIT,
}ClCmThresholdLevelT;
#endif
    
/*
 * Event payload is \e ClAlarmInfoT defined in <em> clAlarmDefinitions.h </em>, the contents
 * of buffer field in alarmPayload is \e ClCmSensorEventInfo defined above.
 */
#define CL_CM_ALARM_EVENT_STR "cmAlarmEvent"


/*
 * These error is returned for any HPI failures occur at the server side,
 * HPI errors are printed on the console or any log file.
 */     

#define CL_ERR_CM_HPI_ERROR             (CL_ERR_COMMON_MAX+1)

#define CL_ERR_CM_HPI_INVALID_PHY_SLOT  (CL_ERR_COMMON_MAX+2)


typedef enum {
    CL_CM_POWERON_REQUEST = 1,
    CL_CM_POWEROFF_REQUEST,
    CL_CM_POWER_CYCLE_REQUEST,
    CL_CM_INSERT_REQUEST,
    CL_CM_EXTRACT_REQUEST,
    CL_CM_RESET_REQUEST,
    CL_CM_WARM_RESET_REQUEST,
    CL_CM_RESET_ASSERT_REQUEST,
    CL_CM_RESET_DEASSERT_REQUEST

} ClCmFruOperationT;
    
#define clCmFruStateGet(hMoId,pState) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED)


#define clCmFruOperationRequest(hMoId,request) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED)

#define clCmVersionVerify(version) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED)

#define clCmBladeOperationRequest(chassisId,physSlot,request)  CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED)

       

    
#define clCmThresholdStateGet(slot, pLevel,pStateAsserted) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED)

#else
    
#include <clCommon.h>
    /* These are automatically called by the EO so not really part of the public interface */    
extern ClRcT clCmLibInitialize(void);
extern ClRcT clCmLibFinalize(void);
    
#include <clChassisMgrApi.h>
    
#endif
    
#ifdef __cplusplus
}
#endif 
#endif /* _CL_CHASSIS_MGR_API_H_ */