spike_processing.h File Reference

Spike processing API. More...

#include <common/neuron-typedefs.h>
#include <common/in_spikes.h>
#include <spin1_api.h>

Go to the source code of this file.

Data Structures
struct	spike_processing_provenance
	Provenance for spike processing. More...

Functions
bool	spike_processing_initialise (size_t row_max_n_bytes, uint mc_packet_callback_priority, uint user_event_priority, uint incoming_spike_buffer_size, bool clear_input_buffers_of_late_packets_init, uint32_t packets_per_timestep_region)
	Initialise the spike processing system.
void	spike_processing_store_provenance (struct spike_processing_provenance *prov)
	Get provenance data for Spike processing.
bool	spike_processing_do_rewiring (int number_of_rewires)
	Set the number of times spike_processing has to attempt rewiring.
void	spike_processing_clear_input_buffer (timer_t time)
	clears the input buffer of packets

Detailed Description

Spike processing API.

Definition in file spike_processing.h.

---

Data Structure Documentation

spike_processing_provenance

struct spike_processing_provenance

Provenance for spike processing.

Definition at line 27 of file spike_processing.h.

Data Fields
uint32_t	n_input_buffer_overflows	A count of the times that the synaptic input circular buffers overflowed.
uint32_t	n_dmas_complete	The number of DMAs performed.
uint32_t	n_spikes_processed	The number of spikes received and processed.
uint32_t	n_rewires	The number of rewires performed.
uint32_t	n_packets_dropped_from_lateness	The number of packets that were cleared at the end of timesteps.
uint32_t	max_filled_input_buffer_size	The maximum size of the input buffer.

Function Documentation

spike_processing_initialise()

bool spike_processing_initialise	(	size_t	row_max_n_bytes,
		uint	mc_packet_callback_priority,
		uint	user_event_priority,
		uint	incoming_spike_buffer_size,
		bool	clear_input_buffers_of_late_packets_init,
		uint32_t	packets_per_timestep_region
	)

Initialise the spike processing system.

Parameters

[in]	row_max_n_bytes	The maximum size of a synaptic row
[in]	mc_packet_callback_priority	Multicast packet receive interrupt priority
[in]	user_event_priority	User event interrupt priority
[in]	incoming_spike_buffer_size	Size of buffer for receiving spikes
[in]	clear_input_buffers_of_late_packets_init	Whether packets that are left at the end of a time step are wiped
[in]	packets_per_timestep_region	The recording region to use for the packets per timestep

Returns

True if initialisation succeeded

Definition at line 430 of file spike_processing.c.

spike_processing_store_provenance()

void spike_processing_store_provenance

(

struct spike_processing_provenance *

prov

)

Get provenance data for Spike processing.

Parameters

[in]

prov

The structure to store the provenance data in

Definition at line 467 of file spike_processing.c.

spike_processing_do_rewiring()

bool spike_processing_do_rewiring

(

int

number_of_rewires

)

Set the number of times spike_processing has to attempt rewiring.

Parameters

[in]

number_of_rewires

The number of rewires to perform

Returns

currently always true

Definition at line 476 of file spike_processing.c.

spike_processing_clear_input_buffer()

void spike_processing_clear_input_buffer

(

timer_t

time

)

clears the input buffer of packets

Parameters

[in]

time

The current timestep

Definition at line 413 of file spike_processing.c.