delay_extension.h File Reference

Declarations for delay extensions. More...

#include <common-typedefs.h>

Go to the source code of this file.

Data Structures
struct	delay_parameters
	Delay configuration, as read from SDRAM where it was placed by DSG or by on-chip generation. More...

Macros
#define	pack_delay_index_stage(index, stage)    ((index & 0xFF) | ((stage & 0xFF) << 8))
	Encode a delay as a 16-bit integer.
#define	unpack_delay_index(packed)   (packed & 0xFF)
	Decode a delay index (encoded with pack_delay_index_stage())
#define	unpack_delay_stage(packed)   ((packed >> 8) & 0xFF)
	Decode a delay stage (encoded with pack_delay_index_stage())

Enumerations
enum	region_identifiers { SYSTEM = 0 , DELAY_PARAMS = 1 , PROVENANCE_REGION = 2 , TDMA_REGION = 3 }
	region identifiers More...

Detailed Description

Declarations for delay extensions.

Definition in file delay_extension.h.

---

Data Structure Documentation

delay_parameters

struct delay_parameters

Delay configuration, as read from SDRAM where it was placed by DSG or by on-chip generation.

Definition at line 41 of file delay_extension.h.

Data Fields
uint32_t	has_key	bool for if this vertex has a key.
uint32_t	key	Key to use for sending messages.
uint32_t	incoming_key	Key to accept messages with.
uint32_t	incoming_mask	Mask to filter delay_parameters::incoming_key.
uint32_t	n_atoms	Number of atoms.
uint32_t	n_delay_stages	Number of delay stages.
uint32_t	n_delay_in_a_stage	Number of delays in a given stage.
uint32_t	clear_packets	Clear packets each timestep?
uint32_t	n_colour_bits	The number of bits used for colour.

Macro Definition Documentation

pack_delay_index_stage

#define pack_delay_index_stage	(		index,
			stage
	)		((index & 0xFF) | ((stage & 0xFF) << 8))

Encode a delay as a 16-bit integer.

Parameters

[in]	index	the index within the stage (uint8_t)
[in]	stage	the stage of the delay (uint8_t)

Returns

The encoded value (uint16_t)

Definition at line 57 of file delay_extension.h.

unpack_delay_index

#define unpack_delay_index

(

packed

)

(packed & 0xFF)

Decode a delay index (encoded with pack_delay_index_stage())

Parameters

[in]

packed

the encoded value

Returns

The delay index

Definition at line 63 of file delay_extension.h.

unpack_delay_stage

#define unpack_delay_stage

(

packed

)

((packed >> 8) & 0xFF)

Decode a delay stage (encoded with pack_delay_index_stage())

Parameters

[in]

packed

the encoded value

Returns

The delay stage

Definition at line 68 of file delay_extension.h.

Enumeration Type Documentation

region_identifiers

enum region_identifiers

region identifiers

Enumerator
SYSTEM	General simulation system control.
DELAY_PARAMS	Delay parameters (see delay_parameters)
PROVENANCE_REGION	Provenance recording region.
TDMA_REGION	tdma data

Definition at line 28 of file delay_extension.h.