LMC_pubdefs.h File Reference

LAT Multiplexed Counters public definitions. More...

#include <PBS/TASK.h>

Typedefs
typedef enum _LMC_CntrType	LMC_CntrType
	LMC counter types.
Enumerations
enum	{   N_TEMS = 16,   N_ACD_TILES = 108,   N_TILES_GRP = 54,   LMC_SCI_APID = 929,   LMC_DGM_SIZE = 65536 }
	Miscellaneous constants. More...
enum	_LMC_CntrType {   LMC_TYP_CAL = 1,   LMC_TYP_TKR = 2,   LMC_TYP_ACD = 3,   LMC_TYP_DEAD = 4 }
	LMC counter types. More...
Functions
unsigned int	LMC_initialize (void)
	Initialize the LMC system.
unsigned int	LMC_start (void)
	Start the LMC system.
unsigned int	LMC_shutdown (void)
	Shut down the LMC system.
unsigned int	LMC_startTask (TASK_attr *attr)
	Create and start the LMC task.
unsigned int	LMC_stopTask (void)
	Stop the LMC task.

---

Detailed Description

LAT Multiplexed Counters public definitions.

Author:

Owen Saxton

Id

LMC_pubdefs.h,v 1.4 2011/03/28 18:05:26 saxton Exp

---

Enumeration Type Documentation

anonymous enum

Miscellaneous constants.

Enumerator:

N_TEMS	Number of TEMs.
N_ACD_TILES	Number of ACD tiles.
N_TILES_GRP	Number of ACD tiles in a packet.
LMC_SCI_APID	APID for science datagrams.
LMC_DGM_SIZE	Maximum science datagram size.

enum _LMC_CntrType

LMC counter types.

Enumerator:

LMC_TYP_CAL	CAL low rate science.
LMC_TYP_TKR	TKR low rate science.
LMC_TYP_ACD	ACD tile pair counters.
LMC_TYP_DEAD	TEM deadtime counters.

---

Function Documentation

unsigned int LMC_initialize

(

void

)

Initialize the LMC system.

Return values:

LMC_SUCCESS

Success

References _LMC_Control::acd_cnt, _LMC_Control::cal_cnt, _LMC_Control::crx_fcb, _LMC_Control::ctx_fcb, _LMC_Control::dead_cnt, _LMC_Control::dtx_fcb, _LMC_Control::hdr_size, _LMC_Control::itc_task, LMC_Apid69c, LMC_CTL_INITIALIZED, LMC_CTL_INITIALIZING, LMC_CTL_UNINITIALIZED, LMC_DGM_SIZE, LMC_K_RESET_FORMAT_0, LMC_NUM_DGMS, LMC_NUM_PKTS, LMC_PKT_SIZE, LMC_TYP_ACD, LMC_TYP_CAL, LMC_TYP_DEAD, LMC_TYP_TKR, _LMC_Control::reset, _LMC_Control::rwi, _LMC_Control::state, _LMC_Control::stx_fcb, _LMC_Control::tkr_cnt, _LMC_Reset::trd, _LMC_Reset::trd_cache, _LMC_reset_valid::uc, _LMC_Reset_Row::valid, and _LMC_Reset::wut.

unsigned int LMC_shutdown

(

void

)

Shut down the LMC system.

Return values:

	LMC_SUCCESS	Success
	LMC_INVSTATE	Not in initialized state

References LMC_CTL_DEINITIALIZING, LMC_CTL_INITIALIZED, _LMC_Control::rwi, and _LMC_Control::state.

unsigned int LMC_start

(

void

)

Start the LMC system.

Return values:

	LMC_SUCCESS	Success
	LMC_NOTINIT	Not initialized

References LMC_startTask().

unsigned int LMC_startTask

(

TASK_attr *

attr

)

Create and start the LMC task.

Parameters:

attr

(in) Task attributes (can be NULL)

Return values:

	LMC_SUCCESS	Success
	LMC_INVSTATE	Not in INITIALIZED state
	ITC_ALOCFAIL	Cannot allocate for fork control block
	ITC_CTLSTAT	ITC control block not in state initialized
	ITC_FORKINIT	Fork initialization failed
	ITC_FORKQHND	Cannot recover all fork queue handles (obscure)
	ITC_NOTINIT	ITC control block does not exist

References _LMC_Control::itc_task, LMC_CTL_INITIALIZED, LMC_CTL_STARTED, LMC_CTL_STARTING, _LMC_Control::rwi, and _LMC_Control::state.

Referenced by LMC_start().

unsigned int LMC_stopTask

(

void

)

Stop the LMC task.

Return values:

	LMC_SUCCESS	Success
	LMC_INVSTATE	Not in STARTED state
	ITC_CTLSTAT	ITC control block not in state initialized
	ITC_NOTINIT	ITC control block does not exist
	ITC_TASKHNDL	Task handle is invalid
	ITC_TASKSTAT	Invalid task state for this operation

References _LMC_Control::itc_task, LMC_CTL_INITIALIZED, LMC_CTL_STARTED, LMC_CTL_STOPPING, _LMC_Control::rwi, and _LMC_Control::state.