cm_ifc.h File Reference

#include "phal_sw_api.h"

Data Structures
struct	flow_config
Defines
#define	TB_INIT   PHAL_STATUS_INIT
#define	TB_RUN   PHAL_STATUS_RUN
#define	TB_STOP   PHAL_STATUS_STOP
#define	FLOW_CORRECT   1
#define	FLOW_ERROR   -1
#define	FLOW_EINVAL   -2
#define	QUERY_SYSERROR   -1
#define	QUERY_TIMEOUT   -2
#define	QUERY_NO_INIT   -3
#define	QUERY_NOREG   -4
#define	QUERY_DATAERR   -6
#define	QUERY_BADPARAM   -7
#define	QUERY_AGAIN   -8
#define	CreateFlow   NewFlow
Functions
int	TestBedStatus ()
int	InitCommManager (int module_id)
int	InitCommManagerN (int module_id, const char *name)
int	CloseCommManager (int module_id)
int	CreateFlow (int module_id, int remote_module, struct flow_config fconf)
int	WriteFlow (int flow_id, unsigned int nof_bytes, void *buffer)
int	ReadFlow (int flow_id, unsigned int nof_bytes, void *buffer)
int	GetFlowStatus (int flow_id)
int	CheckFlow (int flow_id)
int	DeleteFlow (int flow_id)
int	ReadInitFile ()
int	GetParameter (int file_id, char *param_name, void *param)
int	GetParameterMid (int file_id, char *pname, void *param, int mid)
int	WriteMsg (int log_id, int dest, char *short_msg_desc, char *long_msg_desc)
int	WriteVar (int log_id, char *var_name, char *var_value)
int	LogStat (int log_id, int stat_id, int idx)
int	GetNameMid (int mid, char *name, int buffer_size)
int	InitStatistics (int module_id)
int	CreateStat (char *name)
int	SetStatValue (int id, void *value, int idx)
int	GetStatValue (int id, void *value, int idx)
int	SetStatLabel (int vect_id, char *label, int idx)
int	GetStatIndex (int trow_id, char *element_name)
int	GetStatId (int trow_id, char *element_name)
int	DeleteStat (int id)
int	CloseStatistics (int module_id)
int	GetTimeStamp ()
void	UnrecoveryError (char *string)

---

Define Documentation

#define CreateFlow   NewFlow

#define FLOW_CORRECT   1

#define FLOW_EINVAL   -2

#define FLOW_ERROR   -1

#define QUERY_AGAIN   -8

#define QUERY_BADPARAM   -7

#define QUERY_DATAERR   -6

#define QUERY_NO_INIT   -3

#define QUERY_NOREG   -4

#define QUERY_SYSERROR   -1

#define QUERY_TIMEOUT   -2

#define TB_INIT   PHAL_STATUS_INIT

#define TB_RUN   PHAL_STATUS_RUN

#define TB_STOP   PHAL_STATUS_STOP

---

Function Documentation

int CheckFlow

(

int

flow_id

)

int CloseCommManager

(

int

module_id

)

int CloseStatistics

(

int

module_id

)

int CreateFlow	(	int	module_id,
		int	remote_module,
		struct flow_config	fconf
	)

int CreateStat

(

char *

name

)

int DeleteFlow

(

int

flow_id

)

int DeleteStat

(

int

id

)

int GetFlowStatus

(

int

flow_id

)

int GetNameMid	(	int	mid,
		char *	name,
		int	buffer_size
	)

int GetParameter	(	int	file_id,
		char *	param_name,
		void *	param
	)

parameter type and size ???

int GetParameterMid	(	int	file_id,
		char *	pname,
		void *	param,
		int	mid
	)

int GetStatId	(	int	trow_id,
		char *	element_name
	)

int GetStatIndex	(	int	trow_id,
		char *	element_name
	)

int GetStatValue	(	int	id,
		void *	value,
		int	idx
	)

int GetTimeStamp

(

)

int InitCommManager

(

int

module_id

)

int InitCommManagerN	(	int	module_id,
		const char *	name
	)

int InitStatistics

(

int

module_id

)

int LogStat	(	int	log_id,
		int	stat_id,
		int	idx
	)

int ReadFlow	(	int	flow_id,
		unsigned int	nof_bytes,
		void *	buffer
	)

int ReadInitFile

(

)

int SetStatLabel	(	int	vect_id,
		char *	label,
		int	idx
	)

int SetStatValue	(	int	id,
		void *	value,
		int	idx
	)

int TestBedStatus

(

)

void UnrecoveryError

(

char *

string

)

int WriteFlow	(	int	flow_id,
		unsigned int	nof_bytes,
		void *	buffer
	)

int WriteMsg	(	int	log_id,
		int	dest,
		char *	short_msg_desc,
		char *	long_msg_desc
	)

int WriteVar	(	int	log_id,
		char *	var_name,
		char *	var_value
	)