SSRSIM.h File Reference

Module to simulated SSR data output from ISIS. More...

#include <LCBT/TDATA.h>

Functions
void	SSRSIM_init (LCBD lcb, int sendTaskPri, int latpAddr, int appId)
	init the SSR simulate module
void	SSRSIM_release ()
	shutdown the SSR simulate module
int	SSRSIM_setParm (TDATA_DTEST dataType, int dataParm, int tDuration, int reqPacketSize, int evtPeriod, int *actualPacketSize)
	Setup and start data simulated SSR data from ISIS.
void	SSRSIM_stop ()
	stop SSR simulate data output
void	SSRSIM_stats ()
	print stats
void	SSRSIM_statsGetErrors (int *timerMiss, int *dmaErrs, int *itemErrs, int *backPresErrs)
	get error stats
void	SSRSIM_statsReset ()
	reset stats for printing

---

Detailed Description

Module to simulated SSR data output from ISIS.

Author:

Ed Bacho - ebacho@slac.stanford.edu

---

Function Documentation

void SSRSIM_init	(	LCBD	lcb,
		int	sendTaskPri,
		int	latpAddr,
		int	appId
	)

init the SSR simulate module

Parameters:

	lcb	LCB handle
	sendTaskPri	priority of task created to send data to LCB, 0=default of 60
	latpAddr	address of unit to send data to
	appId	appId to be used within the CCSDS header

Returns:

none

References RND_lc0_init(), SSRSIM_statsReset(), and TDATA_setCcsdsParms().

void SSRSIM_release

(

)

shutdown the SSR simulate module

Returns:

none

References SSRSIM_stop().

int SSRSIM_setParm	(	TDATA_DTEST	dataType,
		int	dataParm,
		int	tDuration,
		int	reqPacketSize32,
		int	evtPeriod,
		int *	actualPacketSize32
	)

Setup and start data simulated SSR data from ISIS.

Parameters:

	dataType	data pattern to load into buffer
	dataParm	parameter associated with given dataType
	tDuration	time in secs to output data, -1=forever
	reqPacketSize32	desired packet size, 8 to 1020, 0=random size
	evtPeriod	time in microSec between events, 100 (10KHz) to 30000000 (1/30 Hz)
	actualPacketSize32	returned packet size adjusted down if needed to achieve given evtPeriod within LCB bandwidth constraints, max size is returned if reqPacketSIze=0 for random

Returns:

status 0=sucess

References SSRSIM_stop(), and TDATA_DTEST_RANDOM.

void SSRSIM_stats

(

)

print stats

Returns:

none

References PRINTF.

void SSRSIM_statsGetErrors	(	int *	timerMiss,
		int *	dmaErrs,
		int *	itemErrs,
		int *	backPresErrs
	)

get error stats

Parameters:

	timerMiss	if not NULL, return timer misses which indicates no buffer to send to LCB
	dmaErrs	if not NULL, return dma errs which indicate LCB did not process a list so list is probably incorrect or LCB problems
	itemErrs	if not NULL, return item error which are errors on one item in list, probably indicate cannot talk to destination of item
	backPresErrs	if not NULL, return backpressure errors which indicate timeout due to pause line from EBM being set

Returns:

none

void SSRSIM_statsReset

(

)

reset stats for printing

Returns:

none

Referenced by SSRSIM_init().

void SSRSIM_stop

(

)

stop SSR simulate data output

Returns:

none

Referenced by SSRSIM_release(), and SSRSIM_setParm().