fesParm.h File Reference

Definitions for the parameter system. More...

Enumerations
enum	{   FES_NUM_TDMEM_FIFOS = 4,   FES_NUM_TMEM_FIFOS = FES_NUM_TDMEM_FIFOS,   FES_NUM_DMEM_FIFOS = 2 * FES_NUM_TDMEM_FIFOS,   FES_NUM_FIFOS = FES_NUM_TMEM_FIFOS + FES_NUM_DMEM_FIFOS }
	Basic constants. More...
enum	{   FES_MAX_UNITS = 4,   FES_MAX_DISKS = 4,   FES_MAX_NODES = 20,   FES_DNAME_MAX = 16,   FES_NNAME_MAX = 16,   FES_FNAME_MAX = 255,   FES_PNAME_MAX = 255 }
	Various limits. More...
enum	{   FES_EVTIME_TASK_PRIO = 195,   FES_READER_TASK_PRIO = 194,   FES_TMEM_TASK_PRIO = 191,   FES_DMEM_TASK_PRIO = 192,   FES_MEMTEST_TASK_PRIO = 150,   FES_HB_TASK_PRIO = 198,   FES_WEB_TASK_PRIO = 120,   FES_EMSG_TASK_PRIO = 110,   FES_LEDS_TASK_PRIO = 108,   FES_CMND_TASK_PRIO = 115,   FES_XCTL_TASK_PRIO = 115,   FES_FILE_TASK_PRIO = 200,   FES_INITTIME_TASK_PRIO = 105 }
	Task priorities. More...
enum	{   FES_EVTIME_STACK_SZ = 4 * 1024,   FES_READER_STACK_SZ = 4 * 1024,   FES_TMEM_STACK_SZ = 4 * 1024,   FES_DMEM_STACK_SZ = 4 * 1024,   FES_HB_STACK_SZ = 4 * 1024 }
	Task stack sizes. More...
enum	{   FES_TMEM_REQUEST_QUEUE_DEPTH = 4,   FES_TMEM_RECEIVE_QUEUE_DEPTH = 16,   FES_DMEM_REQUEST_QUEUE_DEPTH = 4,   FES_DMEM_RECEIVE_QUEUE_DEPTH = 16 }
	Request queue depths. More...
enum	{   FES_READ_BUFFER_SIZE = 64 * 1024,   FES_MAX_IN_MEMORY_FILE_SIZE = 24 * 1024 * 1024,   FES_DATA_BUFFER_BUF_SIZE = 128 * 1024,   FES_DATA_BUFFER_BUF_ALIGN = 64 * 1024,   FES_DATA_BUFFER_POOL_NBUFS }
	Buffer and file sizes. More...
enum	{   FES_HB_INTERVAL = 10,   FES_LEDS_INTERVAL = 1 }
	Periodic intervals. More...
enum	{   FES_PORT_FILE = 5001,   FES_PORT_CTL = 5002,   FES_PORT_XCTL = 5003,   FES_PORT_EMSG = 5004 }
	TCP/IP port numbers. More...
enum	{   FES_PRM_STATE = 0,   FES_PRM_RPT_COUNT = 1,   FES_PRM_EVT_TIME = 2,   FES_PRM_EVT_DIST = 3,   FES_PRM_EVT_EXPN = 4,   FES_PRM_ONE_SHOT = 5,   FES_PRM_EVT_SKIP = 6,   FES_PRM_EVT_PROC = 7,   FES_PRM_EVT_NMBRS = 8,   FES_PRM_EVT_GAMMA = 9,   FES_PRM_CAL_STROBE = 10,   FES_PRM_ACD_CS_DELAY = 11,   FES_PRM_CAL_CS_DELAY = 12,   FES_PRM_TKR_CS_DELAY = 13,   FES_PRM_ACD_PATH = 14,   FES_PRM_UP_TIME = 15,   FES_PRM_BRD_MASK = 16,   FES_PRM_UNIT_MASK = 17 }
	System parameter IDs. More...
enum	{   FES_ST_IDLE = 0,   FES_ST_PAUSED = 1,   FES_ST_RUNNING = 2,   FES_ST_EXTRUN = 3,   FES_ST_MEMTEST = 4,   FES_ST_RUNPAUSE = 5,   FES_ST_EXTPAUSE = 6,   FES_ST_INTPAUSE = 7,   FES_ST_MIXED = 8,   FES_ST_UNKNOWN = 9,   FES_ST_MAX = 9 }
	System state values. More...
enum	{   FES_EVD_CONSTANT = 0,   FES_EVD_EXPONENT = 1,   FES_EVD_MAX = 1 }
	Event time distribution values. More...
enum	{   FES_CALIB_EVTIME = 2000,   FES_MIN_INIT_TIME = 31536000 }
	Miscellaneous constants. More...
Functions
int	fesParmGet (int param, void *value)
int	fesParmGetReal (int param, void *value)
int	fesParmInit (const char *file)
int	fesParmSet (int param, const void *value)
int	fesParmShow (void)
int	fesParmStartGet (int unit, int *tick)
int	fesParmStartSet (int unit)
const char *	fesParmStateName (int state)
int	fesParmStopGet (int unit, int *tick)
int	fesParmStopSet (int unit)

---

Detailed Description

Definitions for the parameter system.

Author:

Mark A McDougald, Owen H Saxton

$Id: fesParm.h,v 1.16 2010/07/26 19:05:39 saxton Exp $

---

Enumeration Type Documentation

anonymous enum

Basic constants.

Enumerator:

FES_NUM_TDMEM_FIFOS	Basic number of FIFOs of each type.
FES_NUM_TMEM_FIFOS	Number of TMEM FIFOs.
FES_NUM_DMEM_FIFOS	Number of tracker DMEM FIFOs.
FES_NUM_FIFOS	Maxm number of FIFOs on any board.

anonymous enum

Various limits.

Enumerator:

FES_MAX_UNITS	Maximum units per CPU.
FES_MAX_DISKS	Maximum number of disk drives.
FES_MAX_NODES	Maximum number of nodes in system.
FES_DNAME_MAX	Maximum length of a disk name.
FES_NNAME_MAX	Maximum length of a node name.
FES_FNAME_MAX	Maximum length of a file name (excl. EOS).
FES_PNAME_MAX	Maximum length of a path name (excl. EOS).

anonymous enum

Event time distribution values.

Enumerator:

FES_EVD_CONSTANT	Constant.
FES_EVD_EXPONENT	Exponential.
FES_EVD_MAX	Maximum allowed value.

anonymous enum

Miscellaneous constants.

Enumerator:

FES_CALIB_EVTIME	Event time to use in calib runs.
FES_MIN_INIT_TIME	Minimum valid init time (1 yr past base).

anonymous enum

Task priorities.

The relative priorities of the various tasks are very important. It must be memory tasks < reader tasks < event time task. Lower value has higher priority.

Enumerator:

FES_EVTIME_TASK_PRIO	Event time task priority.
FES_READER_TASK_PRIO	Reader task priority.
FES_TMEM_TASK_PRIO	Transition memory task priority.
FES_DMEM_TASK_PRIO	Data memory task priority.
FES_MEMTEST_TASK_PRIO	Memory test task priority.
FES_HB_TASK_PRIO	Heartbeat task priority.
FES_WEB_TASK_PRIO	Web server task priority.
FES_EMSG_TASK_PRIO	Error message task priority.
FES_LEDS_TASK_PRIO	Board LEDs task priority.
FES_CMND_TASK_PRIO	Command server task priority.
FES_XCTL_TASK_PRIO	External control task priority.
FES_FILE_TASK_PRIO	File server task priority.
FES_INITTIME_TASK_PRIO	Initialization time task priority.

anonymous enum

Task stack sizes.

Enumerator:

FES_EVTIME_STACK_SZ	Event time task stack size.
FES_READER_STACK_SZ	Reader task stack size.
FES_TMEM_STACK_SZ	Transition memory task stack sz.
FES_DMEM_STACK_SZ	Data memory task stack size.
FES_HB_STACK_SZ	Heartbeat task stack size.

anonymous enum

Request queue depths.

Enumerator:

FES_TMEM_REQUEST_QUEUE_DEPTH	TMEM request queue depth.
FES_TMEM_RECEIVE_QUEUE_DEPTH	TMEM receive queue depth.
FES_DMEM_REQUEST_QUEUE_DEPTH	DMEM request queue depth.
FES_DMEM_RECEIVE_QUEUE_DEPTH	DMEM receive queue depth.

anonymous enum

Buffer and file sizes.

Enumerator:

FES_READ_BUFFER_SIZE	Read buffer size.
FES_MAX_IN_MEMORY_FILE_SIZE	Maximum size of file kept in memory.
FES_DATA_BUFFER_BUF_SIZE	Data buffer size.
FES_DATA_BUFFER_BUF_ALIGN	Data buffer alignment.
FES_DATA_BUFFER_POOL_NBUFS	Number of data buffers to allocate.

anonymous enum

Periodic intervals.

Enumerator:

FES_HB_INTERVAL	Heartbeat interval (seconds).
FES_LEDS_INTERVAL	LEDs display interval (seconds).

anonymous enum

TCP/IP port numbers.

Enumerator:

FES_PORT_FILE	File server.
FES_PORT_CTL	Control servers.
FES_PORT_XCTL	External control server.
FES_PORT_EMSG	Error message server.

anonymous enum

System parameter IDs.

Enumerator:

FES_PRM_STATE	System state.
FES_PRM_RPT_COUNT	Data file repeat count.
FES_PRM_EVT_TIME	Inter-event time.
FES_PRM_EVT_DIST	Event time distribution.
FES_PRM_EVT_EXPN	Intra-event time expansion.
FES_PRM_ONE_SHOT	One-shot range.
FES_PRM_EVT_SKIP	Events to skip at start.
FES_PRM_EVT_PROC	Events to process.
FES_PRM_EVT_NMBRS	Event numbers option.
FES_PRM_EVT_GAMMA	Gamma event flag option.
FES_PRM_CAL_STROBE	Calibration strope option.
FES_PRM_ACD_CS_DELAY	ACD calstrobe delay.
FES_PRM_CAL_CS_DELAY	CAL calstrobe delay.
FES_PRM_TKR_CS_DELAY	TKR calstrobe delay.
FES_PRM_ACD_PATH	ACD path in use.
FES_PRM_UP_TIME	Up (booted) time.
FES_PRM_BRD_MASK	Global mask of board IDs.
FES_PRM_UNIT_MASK	Local mask of board units.

anonymous enum

System state values.

Enumerator:

FES_ST_IDLE	Idle.
FES_ST_PAUSED	Paused.
FES_ST_RUNNING	Running.
FES_ST_EXTRUN	Running under external control.
FES_ST_MEMTEST	Memory test.
FES_ST_RUNPAUSE	Running, FPGAs paused.
FES_ST_EXTPAUSE	Ext run, FPGAs paused.
FES_ST_INTPAUSE	Ext run, FPGAs paused internally.
FES_ST_MIXED	Mixed.
FES_ST_UNKNOWN	Unknown.
FES_ST_MAX	Maximum allowed value.