clCpmExtApi.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.
 */

#ifndef _CL_CPM_EXT_API_H_
#define _CL_CPM_EXT_API_H_

#ifdef __cplusplus
extern "C"
{
#endif

#include <clCommon.h>
#include <clCommonErrors.h>
#include <clCpmApi.h>

#include <clEventApi.h>
#include <clCorMetaData.h>

/*
 * The static target slot/target info read from targetconf.xml
 */

typedef struct ClTargetSlotInfo
{
    ClCharT name[80];
    ClInt32T addr;
    ClCharT linkname[40];
    ClCharT arch[80];
    /*
     * A private data store per node/slot referenced from the private xml tag
     */
    ClCharT customData[256];
} ClTargetSlotInfoT;

typedef struct ClTargetInfo
{
    ClCharT version[80];
    ClCharT trapIp[40];
    ClBoolT installPrerequisites;
    ClBoolT instantiateImages;
    ClBoolT createTarballs;
    ClInt32T tipcNetid;
    ClInt32T gmsMcastPort;
    ClUint32T numSlots;
} ClTargetInfoT;

typedef enum
{
    CL_CPM_SLOT_ID,
    CL_CPM_IOC_ADDRESS,
    CL_CPM_NODE_MOID,
    CL_CPM_NODENAME,

} ClCpmSlotInfoFieldIdT;

typedef struct
{
    ClUint32T           slotId;
    ClIocNodeAddressT   nodeIocAddress;
    ClCorMOIdT          nodeMoId;
    ClNameT             nodeName;
}ClCpmSlotInfoT;

/*
 * CPM node config set.
 */
typedef struct ClCpmNodeConfig
{
    ClCharT nodeName[CL_MAX_NAME_LENGTH];
    ClNameT nodeType;
    ClNameT nodeIdentifier;
    ClNameT nodeMoIdStr;
    ClCharT cpmType[CL_MAX_NAME_LENGTH];
}ClCpmNodeConfigT;

typedef enum
{
    CL_CPM_COMP_EVENT,
    CL_CPM_NODE_EVENT
} ClCpmEventTypeT;
    
extern ClRcT clCpmEventPayLoadExtract(CL_IN ClEventHandleT eventHandle, 
                                      CL_IN ClSizeT eventDataSize,
                                      CL_IN ClCpmEventTypeT cpmEventType,
                                      CL_OUT void *payLoad);

extern ClRcT clCpmComponentPIDGet(CL_IN ClNameT *compName,
                                  CL_OUT ClUint32T *pid);

/*
 * CM requirement.
 * Single function which returns the consolidated information
 * about the slot.
 */
extern ClRcT clCpmSlotInfoGet(CL_IN ClCpmSlotInfoFieldIdT flag,
                              CL_OUT ClCpmSlotInfoT *slotInfo);


extern ClRcT clCpmSlotGet(CL_IN ClCpmSlotInfoFieldIdT flag,
                          CL_OUT ClCpmSlotInfoT *slotInfo);


extern ClRcT clCpmIocAddressForNodeGet(CL_IN ClNameT nodeName, 
                                       CL_OUT ClIocAddressT *pIocAddress);

extern ClBoolT clCpmIsCompRestarted(CL_IN ClNameT compName);

extern ClRcT clCpmNodeConfigSet(ClCpmNodeConfigT *nodeConfig);

extern ClRcT clCpmNodeConfigGet(const ClCharT *nodeName, ClCpmNodeConfigT *nodeConfig);

extern ClRcT clCpmCompConfigSet(ClIocNodeAddressT node, 
                                ClCharT *name, ClCharT *instantiateCommand,
                                ClAmsCompPropertyT property, ClUint64T mask);

extern ClRcT
clCpmComponentFailureReportWithCookie(CL_IN ClCpmHandleT cpmHandle,
                                      CL_IN const ClNameT *pCompName,
                                      CL_IN ClUint64T instantiateCookie,
                                      CL_IN ClTimeT errorDetectionTime,
                                      CL_IN ClAmsLocalRecoveryT recommendedRecovery,
                                      CL_IN ClUint32T alarmHandle);

extern ClRcT 
clCpmTargetSlotInfoGet(const ClCharT *name, ClIocNodeAddressT addr, ClTargetSlotInfoT *slotInfo);

extern ClRcT 
clCpmTargetInfoGet(ClTargetInfoT *targetInfo);

extern ClRcT
clCpmTargetSlotListGet(ClTargetSlotInfoT *slotInfo, ClUint32T *numSlots);

extern ClRcT
clCpmTargetVersionGet(ClCharT *aspVersion, ClUint32T maxBytes);

extern ClBoolT 
clCpmIsSCCapable(void);

#ifdef __cplusplus
}
#endif

#endif                          /* _CL_CPM_EXT_API_H_*/