lci_p.h File Reference

Internal definitions for the LCI system. More...

#include <LCI/lci.h>
#include <LSEC/LSEC.h>
#include <EDS/EBF_pkt.h>
#include <EDS/EBF_dir.h>
#include <LCBD/LCBD_evt.h>
#include <LEM/list.h>
#include <ITC/ITC_pubdefs.h>
#include <stdio.h>

Typedefs
typedef struct _LCI_controller	LCI_controller
	Declaration of the opaque controller structure.
typedef struct _LCI_collection	LCI_collection
	Declaration of the opaque collection structure.
typedef struct _LCI_configuration	LCI_configuration
	Declaration of the opaque configuration structure.
typedef struct _LCI_cue	LCI_cue
	Declaration of the opaque cue structure.
Enumerations
enum	{   LCI_CNF_MAJ = 6,   LCI_CNF_MIN = 0 }
	Current version.
enum	{   LCI_MIN_PERIOD = 20000,   LCI_DEF_PERIOD = 20000,   LCI_CNF_ULATC = 0xffff,   LCI_CNF_INCREMENTED = 0,   LCI_CNF_RESTARTED = 1,   LCI_CNF_NO_RELOAD = 0,   LCI_CNF_RELOAD = 1,   GEM_N_TAM_REGS = 16,   GEM_N_SCHD_REGS = 32 }
	Configuration constants.
enum	_LCI_monType {   LCI_MON_TIMES = 0x01,   LCI_MON_CYCLES = 0x02 }
	Monitoring type flags. More...
enum	LCI_CUE_END {   LCI_CUE_FAILED = -1,   LCI_CUE_UNSET = 0,   LCI_CUE_SIGNALED = 1,   LCI_CUE_TIMEDOUT = 2 }
	State information returned from LCI_waitCue indicating how the cue was terminated. More...
Functions
void	LCI_abort (void)
unsigned	LCI_calibrate (unsigned latccfg, unsigned lcicfg, unsigned lcirunid, ITC_NodeID iniNode, ITC_TaskID iniTask, ITC_QueueID iniQueue)
void	LCI_cb_statusFree (ITC_QueueItem *qitem, unsigned int status, void *prm0, void *prm1, void *prm2, unsigned int tx)
unsigned	LCI_comp (unsigned comp)
unsigned	LCI_cycle (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
unsigned	LCI_cycles (void)
void	LCI_deleteController (LCI_controller *cnt)
unsigned	LCI_init (unsigned capacity, unsigned cpuid, unsigned srcid)
unsigned	LCI_monitor (unsigned mon)
LCI_controller *	LCI_newController (unsigned cap, unsigned cpuid, unsigned srcid)
unsigned	LCI_start (const TASK_attr *attr)
unsigned	LCI_startCycle (void)
unsigned	LCI_status (void)
unsigned	LCI_terminate (unsigned status)
void	LCI_collClearCounts (LCI_collection *cll)
void	LCI_collCounts (LCI_collection *cll, unsigned int *nWait, unsigned int *nSignal, unsigned int *nTimeout)
LCI_collection *	LCI_collCreate (LSEC_control *lsec)
void	LCI_collDelete (LCI_collection *cll)
unsigned	LCI_collect (LCI_collection *cll, unsigned nev, unsigned period)
unsigned	LCI_collected (LCI_collection *cll)
void	LCI_collRunInit (LCI_collection *cll, LCBD lcbd, LEM_micr *cr)
void	LCI_collRunTerm (LCI_collection *cll)
void	LCI_collTime (LCI_collection *cll, int clear, long long *ctime)
unsigned	LCI_confBufferModel (unsigned select, LEM_micr *cr, unsigned *mods)
unsigned	LCI_confCache (LCI_configuration *cnf, unsigned latc_fid)
unsigned	LCI_confClose (LCI_configuration *cnf)
void	LCI_confCopy (LCI_configuration *cnfIn, LCI_configuration *cnfOut)
LCI_configuration *	LCI_confCreate (LSEC_control *lsec)
void	LCI_confDelete (LCI_configuration *cnf)
unsigned	LCI_configure (LCI_configuration *cnf, LEM_micr *cr, unsigned runId)
unsigned	LCI_confMode (LCI_configuration *cnf)
void	LCI_confNodeId (LCI_configuration *cnf, unsigned siu_id)
unsigned	LCI_confOpen (LCI_configuration *cnf, const char *fn)
unsigned	LCI_confOpenFid (LCI_configuration *cnf, unsigned fid)
unsigned	LCI_confPeriod (LCI_configuration *cnf)
unsigned	LCI_confRead (LCI_configuration *cnf)
void	LCI_confReport (LCI_configuration *cnf, FILE *fp)
void	LCI_confTimes (LCI_configuration *cnf, int clear, long long *lci_time, long long *lat_time)
unsigned	LCI_confTriggers (LCI_configuration *cnf)
void	LCI_clearCue (LCI_cue *cue)
void	LCI_clearCueCounts (LCI_cue *cue)
unsigned	LCI_deleteCue (LCI_cue *cue)
void	LCI_getCueCounts (LCI_cue *cue, unsigned int *nWait, unsigned int *nSignal, unsigned int *nTimeout)
LCI_cue *	LCI_newCue (void)
void	LCI_signalCue (LCI_cue *cue)
unsigned	LCI_waitCue (LCI_cue *cue, unsigned timeout)
Variables
enum _LCI_monType	LCI_monType

---

Detailed Description

Internal definitions for the LCI system.

Author:

James Swain & Owen Saxton

$Id: lci_p.h,v 1.2 2011/03/29 19:32:57 saxton Exp $

---

Enumeration Type Documentation

enum _LCI_monType

Monitoring type flags.

Enumerator:

LCI_MON_TIMES	Show times at the end of a calibration.
LCI_MON_CYCLES	Show cycle number at start of each cycle.

enum LCI_CUE_END

State information returned from LCI_waitCue indicating how the cue was terminated.

Enumerator:

LCI_CUE_FAILED	The wake-up timer failed to start.
LCI_CUE_UNSET	No end state to report (the cue has never been used or is currently waiting)
LCI_CUE_SIGNALED	The cue was signalled.
LCI_CUE_TIMEDOUT	The wake-up timer went off.