Function provided to assist in system debugging.

Functions
int	xsp3_get_scope (int path, int card, u_int32_t *scope_chn, u_int32_t *scope_src, u_int32_t *scope_nwd, u_int32_t *scope_alt)
	Get scope mode registers.
int	xsp3_set_scope_stream (int path, int card, int stream, u_int32_t chan, u_int32_t src, u_int32_t alt)
	Setup individual scope stream.
int	xsp3_set_scope_options (int path, int card, Xsp3ScopeOptions options)
	Setup scope mode options.
int	xsp3_scope_settings_to_mod (int path)
	Get scope mode options.
int	xsp3_scope_settings_from_mod (int path)
	Get scope settings from data module and write into hardware.
int	xsp3_write_dram (int path, int card, int address, int size, u_int32_t *value)
	Write a series of values into DRAM memory for all or each specified card.
int	xsp3_set_scope_search (int path, int chan, u_int32_t scope_search)
	Set the value of the scope search register for specialist factory debug.
int	xsp3_get_scope_search (int path, int chan, u_int32_t *scope_search)
	Get the value of the scope search register for specialist factory debug.
int	xsp3_get_glob_time_statA (int path, int card, u_int32_t *time)
	Get the timing status register A.
int	xsp3_write_fan_cont (int path, int card, int offset, int size, u_int32_t *value)
	Write a series of values into the fan controller data structure.
int	xsp3_read_fan_cont (int path, int card, int offset, int size, u_int32_t *value)
	Read a series of values from the fan control data structure for the specified card.
int	xsp3_playback_load_x2 (int path, int card, char *filename, int do_test, int do_scale, int do_swap)
	Load Playback data from an XSPRESS2 scope mode file.
int	xsp3_playback_load_x3 (int path, int card, char *filename, int src0, int src1, int file_streams, int str0dig)
	Load Playback data from an XSPRESS3 scope mode file.
int	xsp3_dma_build_test_pat (int path, int card, u_int32_t stream, XSP3_DMA_MsgTestPat *msg)
	Instruct PPC1 in the Virtex-5 to build test patterns into the FFEM DRAM.
int	xsp3_dma_print_data (int path, int card, u_int32_t stream, XSP3_DMA_MsgPrint *msg)
	Instruct PPC1 in the Virtex-5 to build print data from DRAM.
int	xsp3_dma_print_scope_data (int path, int card, XSP3_DMA_MsgPrint *msg)
	Instruct PPC1 in the Virtex-5 to build print scope data from DRAM.
int	xsp3_dma_print_desc (int path, int card, u_int32_t stream, XSP3_DMA_MsgPrintDesc *msg)
	Instruct PPC1 in the Virtex-5 to build print the DMA descriptors This is printed onto the console for PPC1, accessible only via a serial cable onto the header on the FEM.
int	xsp3_set_ppc_debuglevel (int path, int card, int ppc1, int ppc2, int level)
	Setup the number of debug messages printed to the serial ports on the FEM directly from the embedded PowerPCs.
int	xsp3_histogram_get_dropped (int path, int chan)
	Read how many missed UDP packets of data have been detected since last start.
int	xsp3_histogram_write_test_pat (int path, Xsp3TestPattern type)
	Write a test pattern into histogramming memory.
int	xsp3_mdio_set_connection (int path, int card, int conn)
	Set conection type to MDIO interface on FMC, via Aux connector or via FMC connector.
int	xsp3_mdio_display (int path, int card)
	Read and print data from the AEL2005 10GE PHY.
int	xsp3_mdio_write (int path, int card, int port, int device, int addr, int data)
	Write data to the AEL2005 10GE PHY.
int	xsp3_mdio_read (int path, int card, int port, int device, int addr, u_int32_t *data)
	Read data from the AEL2005 10GE PHY.
int	xsp3_mdio_read_inc (int path, int card, int port, int device, u_int32_t *data)
	Read data from the AEL2005 10GE PHY andincrement internal address.
u_int16_t *	xsp3_scope_mod_get_ptr (XSP3ScopeModule *mod, int card, int stream)
	Get pointer to data for specifed card and stream with the data module.
int	xsp3_scope_mod_get_inc (XSP3ScopeModule *mod)
	Get increment to use when stepping to next time point when accessing data in the scope mode data module.
int	xsp3_scope_mod_get_nstreams (XSP3ScopeModule *mod)
	Get number of streams per card for current scope mode data module layout.
int	xsp3_scope_get_str_sel (XSP3ScopeModule *mod, int card, int stream)
	Get source select for specified stream allowing for any special interpretation of scope mode data module layout.
const char *	xsp3_scope_stream_name (XSP3ScopeModule *mod, int card, int stream)
	Return a label to desribe the describe the data on a given scope stream.
int	xsp3_scope_stream_flags (XSP3ScopeModule *mod, int card, int stream)
	Return Flags describing how to interpret scope mode data for give stream.
int	xsp3_scope_chan (XSP3ScopeModule *mod, int card, int stream)
	Return Channel number (currently within card) for specified stream.
XSP3ScopeModule *	xsp3_scope_get_module (int path)
	Get a pointer to the scope data module.

---

Function Documentation

int xsp3_dma_build_test_pat	(	int	path,
		int	card,
		u_int32_t	stream,
		XSP3_DMA_MsgTestPat *	msg
	)

Instruct PPC1 in the Virtex-5 to build test patterns into the FFEM DRAM.

The following describes the layout of the structure. xspress3_dma_protocol.h XSP3_DMA_MSG_TEST_PAT

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream	Stream number to build test patterns for defined in XSP3_DMA_STREAM_NUMBER.
	msg

Returns:

XSP3_OK or a negative error code.

int xsp3_dma_print_data	(	int	path,
		int	card,
		u_int32_t	stream,
		XSP3_DMA_MsgPrint *	msg
	)

Instruct PPC1 in the Virtex-5 to build print data from DRAM.

This is printed onto the console for PPC1, accessible only via a serial cable onto the header on the FEM. The following describes the layout of the structure. xspress3_dma_protocol.h XSP3_DMA_MSG_PRINT

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream	Stream number to print data from defined in XSP3_DMA_STREAM_NUMBER.
	msg

Returns:

XSP3_OK or a negative error code.

int xsp3_dma_print_desc	(	int	path,
		int	card,
		u_int32_t	stream,
		XSP3_DMA_MsgPrintDesc *	msg
	)

Instruct PPC1 in the Virtex-5 to build print the DMA descriptors This is printed onto the console for PPC1, accessible only via a serial cable onto the header on the FEM.

The following describes the layout of the structure. xspress3_dma_protocol.h XSP3_DMA_MSG_PRINT_DESC

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream	Stream number to print descriptors from defined in XSP3_DMA_STREAM_NUMBER.
	msg

Returns:

XSP3_OK or a negative error code.

int xsp3_dma_print_scope_data	(	int	path,
		int	card,
		XSP3_DMA_MsgPrint *	msg
	)

Instruct PPC1 in the Virtex-5 to build print scope data from DRAM.

This is printed onto the console for PPC1, accessible only via a serial cable onto the header on the FEM. The data is formatted undesrstanding the scope mode data layout.

The following describes the layout of the structure. xspress3_dma_protocol.h XSP3_DMA_MSG_PRINT

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	msg

Returns:

XSP3_OK or a negative error code.

int xsp3_get_glob_time_statA	(	int	path,
		int	card,
		u_int32_t *	time
	)

Get the timing status register A.

The following definitions describe the layout of the global time A register xspress3.h XSP3_GLOBAL_TIME_STATUS_A

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	time	pointer to the timing status a register

Returns:

XSP3_OK or a negative error code.

int xsp3_get_scope	(	int	path,
		int	card,
		u_int32_t *	scope_chn,
		u_int32_t *	scope_src,
		u_int32_t *	scope_nwd,
		u_int32_t *	scope_alt
	)

Get scope mode registers.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	scope_chn
	scope_src
	scope_nwd
	scope_alt

Returns:

XSP3_OK or a negative error code.

int xsp3_get_scope_search	(	int	path,
		int	chan,
		u_int32_t *	scope_search
	)

Get the value of the scope search register for specialist factory debug.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	chan	is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1)
	scope_search	the returned register value.

Returns:

XSP3_OK or a negative error code.

int xsp3_histogram_get_dropped	(	int	path,
		int	chan
	)

Read how many missed UDP packets of data have been detected since last start.

The hardware add trailers to each UDP packet with a concept of a packet and frame number. The frame is a hardware local link concept. In histogramming there is usually 1 packet per frame. When sending data from FEM DRAM to the PC over 10Ge, the data is sent in larger multi-packet frames. The histogramming thread inspected the trailer flags, packet number and frame number to detect missing packets and estimate the number lost.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	chan	is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1) For single histogramming thread per car versions, there is only 1 dropped frame counter per card reading any channel on that card should give the same answer.

Returns:

Number of dropped packets, 0 if none lost or a negative error code.

int xsp3_histogram_write_test_pat	(	int	path,
		Xsp3TestPattern	type
	)

Write a test pattern into histogramming memory.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	type	enumerated test pattern type.

Returns:

XSP3_OK or a negative error code.

int xsp3_mdio_display	(	int	path,
		int	card
	)

Read and print data from the AEL2005 10GE PHY.

This is allowed debugging of the Hitech FMC card. The chip is now setup by the Virtex-5 PPC2 code.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.

Returns:

XSP3_OK

int xsp3_mdio_read	(	int	path,
		int	card,
		int	port,
		int	device,
		int	addr,
		u_int32_t *	data
	)

Read data from the AEL2005 10GE PHY.

This is allowed debugging of the Hitech FMC card. The chip is now setup by the Virtex-5 PPC2 code.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	port
	device
	addr
	data

Returns:

int xsp3_mdio_read_inc	(	int	path,
		int	card,
		int	port,
		int	device,
		u_int32_t *	data
	)

Read data from the AEL2005 10GE PHY andincrement internal address.

This is allowed debugging of the Hitech FMC card. The chip is now setup by the Virtex-5 PPC2 code.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	port
	device
	data

Returns:

int xsp3_mdio_set_connection	(	int	path,
		int	card,
		int	conn
	)

Set conection type to MDIO interface on FMC, via Aux connector or via FMC connector.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	conn	0 => via FMC, 1=> via Aux connector

Returns:

XSP3_OK

int xsp3_mdio_write	(	int	path,
		int	card,
		int	port,
		int	device,
		int	addr,
		int	data
	)

Write data to the AEL2005 10GE PHY.

This is allowed debugging of the Hitech FMC card. The chip is now setup by the Virtex-5 PPC2 code.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	port
	device
	addr
	data

Returns:

int xsp3_playback_load_x2	(	int	path,
		int	card,
		char *	filename,
		int	do_test,
		int	do_scale,
		int	do_swap
	)

Load Playback data from an XSPRESS2 scope mode file.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	filename	File name to laod
	do_test	Create test data rather than reading file.
	do_scale	Scale the 14 bit data to 16 bit by multiplying by 4
	do_swap	Byte swap the data if written in Motorola Byte order

Returns:

XSP3_OK or a negative error code.

int xsp3_playback_load_x3	(	int	path,
		int	card,
		char *	filename,
		int	src0,
		int	src1,
		int	file_streams,
		int	str0dig
	)

Load Playback data from an XSPRESS3 scope mode file.

The XSPRESS3 scope mode file should contain 1 to 6 streams of raw ADC data. There are only two playback streams. The source foreach play stream is selecte dfro mteh 1..6 in the files using src0 and src1. Stream 0 may optionally hold the detector reset signals, in which case detetcor resets are coded into the analogue data.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	filename	File name to laod
	src0	Specify which stream in the Scope mode file (0..5) to be used from playback 0
	src1	Specify which stream in the Scope mode file (0..5) to be used from playback 1
	file_streams	Specify how many streams are in the raw 16 bit binary file, if 0 guess from file size.
	str0dig	Stream 0 of scope moed data is digital (detecor reset) data.

Returns:

XSP3_OK or a negative error code.

int xsp3_read_fan_cont	(	int	path,
		int	card,
		int	offset,
		int	size,
		u_int32_t *	value
	)

Read a series of values from the fan control data structure for the specified card.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	offset	an address offset from the start of the fan control structure.
	size	the size of the array of values to read.
	value	an array to receive a series of 32 bit integer values.

Returns:

XSP3_OK or a negative error code.

int xsp3_scope_chan	(	XSP3ScopeModule *	mod,
		int	card,
		int	stream
	)

Return Channel number (currently within card) for specified stream.

Parameters:

	mod	Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream

Returns:

Integer channel number

XSP3ScopeModule* xsp3_scope_get_module

(

int

path

)

[read]

Get a pointer to the scope data module.

Parameters:

path

a handle to the top level of the xspress3 system returned from xsp3_config().

Returns:

a pointer to the data module or NULL if it does not exist.

int xsp3_scope_get_str_sel	(	XSP3ScopeModule *	mod,
		int	card,
		int	stream
	)

Get source select for specified stream allowing for any special interpretation of scope mode data module layout.

Parameters:

mod

Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly. card Card Number (0 for signle box system) stream Stream number 0..5 for original firmware.

Returns:

Integer number of streams card, -1 for error..

int xsp3_scope_mod_get_inc

(

XSP3ScopeModule *

mod

)

Get increment to use when stepping to next time point when accessing data in the scope mode data module.

For the origianl layout, to minimise processing, the data is arranged to suit the hardware limitations of the Virtex-5. Each streams data is 16 bit data intereleaved so an increment of 3 words is needed to get to the next word of the stream. This is XSP3_SCOPE_MOD_LAYOUT_2X3.

Parameters:

mod

Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.

Returns:

Integer increment, -1 for error..

int xsp3_scope_mod_get_nstreams

(

XSP3ScopeModule *

mod

)

Get number of streams per card for current scope mode data module layout.

For the origianl layout, to minimise processing, the data is arranged to suit the hardware limitations of the Virtex-5. Each streams data is 16 bit data intereleaved so an increment of 3 words is needed to get to the next word of the stream. This is XSP3_SCOPE_MOD_LAYOUT_2X3.

Parameters:

mod

Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.

Returns:

Integer number of streams card, -1 for error..

u_int16_t* xsp3_scope_mod_get_ptr	(	XSP3ScopeModule *	mod,
		int	card,
		int	stream
	)

Get pointer to data for specifed card and stream with the data module.

For the origianl layout, to minimise processing, the data is arranged to suit the hardware limitations of the Virtex-5. Each streams data is 16 bit data intereleaved so an increment of 3 words is needed to get to the next word of the stream. This is XSP3_SCOPE_MOD_LAYOUT_2X3.

Parameters:

	mod	Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream	0...5 for XSP3_SCOPE_MOD_LAYOUT_2X3, 0..9 for XSP3_SCOPE_MOD_LAYOUT_DIFFS_TEST

Returns:

Pointer to the 16 bit data.

int xsp3_scope_settings_from_mod

(

int

path

)

Get scope settings from data module and write into hardware.

Copy the scope settings from the xspress3 scope mode shared memory module which may have been set via the imgd display program GUI into hardware so the next scope run uses these settings.

Parameters:

path

a handle to the top level of the xspress3 system returned from xsp3_config().

Returns:

XSP3_OK or a negative error code.

int xsp3_scope_settings_to_mod

(

int

path

)

Get scope mode options.

For debug purposes, the system provides the capability to stream 6 off 16 bits streams to memory per card, recording raw ADC data or data from various points through the processing. Usually the scope mode recording starts as soon as the run bit is asserted. However, to syncronise across cards, it is possible to make scope mode wait until the Veto (Count enb) signal is asseted. This can be routed from board to board using the TTL LEMOS signals or otherwise.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration. If card is less than 0 then all cards are selected.
	options	Scope mode options defined by

Returns:

XSP3_OK or a negative error code.

Set scope settings in the data module from hardware.

Copy the scope settings from hardware to the xspress3 scope mode shared memory module so display program can interpret and label the data.

Parameters:

path

a handle to the top level of the xspress3 system returned from xsp3_config().

Returns:

XSP3_OK or a negative error code.

int xsp3_scope_stream_flags	(	XSP3ScopeModule *	mod,
		int	card,
		int	stream
	)

Return Flags describing how to interpret scope mode data for give stream.

The 16 bits data can used as unsigned (e.g. fro raw ADC data) or signed (e.g. 1st differential of data in the trigger). The first stream is often used to hold the digital data associated with the remaining 5 streams per card. This is codes in the flags XSP3_SCOPE_FLAGS_SIGNED and XSP3_SCOPE_SEL0_DIGITAL

Parameters:

	mod	Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream

Returns:

Flags desciribe data as XSP3_SCOPE_SEL0_DIGITAL or XSP3_SCOPE_FLAGS_SIGNED

const char* xsp3_scope_stream_name	(	XSP3ScopeModule *	mod,
		int	card,
		int	stream
	)

Return a label to desribe the describe the data on a given scope stream.

Parameters:

	mod	Pointer to scope mode module, usually returned by xsp3_scope_get_module or by linking to module directly.
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	stream

Returns:

int xsp3_set_ppc_debuglevel	(	int	path,
		int	card,
		int	ppc1,
		int	ppc2,
		int	level
	)

Setup the number of debug messages printed to the serial ports on the FEM directly from the embedded PowerPCs.

To view this data it is necessary to connect to the headers on the FEM. Verbose messages slow down the system very significantly, so should only be enabled for detailed debugging.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration.
	ppc1
	ppc2
	level

Returns:

XSP3_OK or a negative error code.

int xsp3_set_scope_options	(	int	path,
		int	card,
		Xsp3ScopeOptions	options
	)

Setup scope mode options.

For debug purposes, the system provides the capability to stream 6 off 16 bits streams to memory per card, recording raw ADC data or data from various points through the processing. Usually the scope mode recording starts as soon as the run bit is asserted. However, to syncronise across cards, it is possible to make scope mode wait until the Veto (Count enb) signal is asserted. This can be routed from board to board using the TTL LEMOS signals or otherwise.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration. If card is less than 0 then all cards are selected.
	options	Scope mode options defined by Xsp3ScopeOptions

Returns:

XSP3_OK or a negative error code.

int xsp3_set_scope_search	(	int	path,
		int	chan,
		u_int32_t	scope_search
	)

Set the value of the scope search register for specialist factory debug.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	chan	is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1) if chan is less than 0 then all channels are selected.
	scope_search	the register value to set.

Returns:

XSP3_OK or a negative error code.

int xsp3_set_scope_stream	(	int	path,
		int	card,
		int	stream,
		u_int32_t	chan,
		u_int32_t	src,
		u_int32_t	alt
	)

Setup individual scope stream.

For debug purposes, the system provides the capability to stream 6 off 16 bits streams to memory per card, recording raw ADC data or data from various points through the processing. The data source for eac hstream is setup in terms of a channel number (within the card),the data source and some alternate options. This function splices the bits for the specifeid stream into the scope control registers.

The data source options are different for each stream. Oftern stream 0 is set to record digital bits associated with the other 5 streams. See xspress3.h XSP3_SCOPE_SOURCES

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration. If card is less than 0 then all cards are selected.
	stream	Stream numer 0..5
	chan	Channel number within the card
	src	Data source.
	alt	Data source alternate.

Returns:

XSP3_OK or a negative error code.

int xsp3_write_dram	(	int	path,
		int	card,
		int	address,
		int	size,
		u_int32_t *	value
	)

Write a series of values into DRAM memory for all or each specified card.

This uses the 1Gbit/s interface and is slow. The bulk playback data is uploaded via the 10 GBit link using the fucntion xsp3_write_playback_data.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration. If card is less than 0 then all cards are selected.
	address	an address offset into DRAM memory.
	size	the size of the array of values to write.
	value	an array of 32 bit integer values to write.

Returns:

XSP3_OK or a negative error code.

int xsp3_write_fan_cont	(	int	path,
		int	card,
		int	offset,
		int	size,
		u_int32_t *	value
	)

Write a series of values into the fan controller data structure.

Parameters:

	path	a handle to the top level of the xspress3 system returned from xsp3_config().
	card	is the number of the card in the xspress3 system, 0 for a single card system and up to (xsp3_get_num_cards() - 1) for a multi-card system, where this value has been passed to xsp3_config() at xspress3 system configuration. If card is less than 0 then all cards are selected.
	offset	an address offset from the start of the fan control region.
	size	the size of the array of values to write.
	value	an array of 32 bit integer values to write.

Returns:

XSP3_OK or a negative error code.