SpiNNFrontEndCommon 7.3.1
Common support code for user-facing front end systems.
Loading...
Searching...
No Matches
Macros | Typedefs | Enumerations
buffered_eieio_defs.h File Reference

Definitions for the streaming-over-EIEIO buffering protocol. More...

Go to the source code of this file.

Macros

#define MAX_SEQUENCE_NO   0xFF
 The maximum sequence number.
 

Typedefs

typedef uint16_teieio_msg_t
 pointer to an EIEIO message
 

Enumerations

enum  eieio_command_messages {
  EVENT_PADDING = 2 , EVENT_STOP_COMMANDS , STOP_SENDING_REQUESTS , START_SENDING_REQUESTS ,
  SPINNAKER_REQUEST_BUFFERS , HOST_SEND_SEQUENCED_DATA , SPINNAKER_REQUEST_READ_DATA , HOST_DATA_READ ,
  HOST_DATA_READ_ACK = 12
}
 The different command message IDs. More...
 
enum  buffered_operations { BUFFER_OPERATION_READ , BUFFER_OPERATION_WRITE }
 The different buffer operations. More...
 

Detailed Description

Definitions for the streaming-over-EIEIO buffering protocol.

Note that this protocol is now mostly deprecated in favour of the substantially-faster automatic pause-and-resume protocol.

Definition in file buffered_eieio_defs.h.

Macro Definition Documentation

◆ MAX_SEQUENCE_NO

#define MAX_SEQUENCE_NO   0xFF

The maximum sequence number.

Definition at line 61 of file buffered_eieio_defs.h.

Typedef Documentation

◆ eieio_msg_t

pointer to an EIEIO message

Definition at line 58 of file buffered_eieio_defs.h.

Enumeration Type Documentation

◆ eieio_command_messages

The different command message IDs.

Enumerator
EVENT_PADDING 

Fill in buffer area with padding.

EVENT_STOP_COMMANDS 

End of all buffers, stop execution.

STOP_SENDING_REQUESTS 

Stop complaining that there is SDRAM free space for buffers.

START_SENDING_REQUESTS 

Start complaining that there is SDRAM free space for buffers.

SPINNAKER_REQUEST_BUFFERS 

SpiNNaker requesting new buffers for spike source population.

HOST_SEND_SEQUENCED_DATA 

Buffers being sent from host to SpiNNaker.

SPINNAKER_REQUEST_READ_DATA 

Buffers available to be read from a buffered out vertex.

HOST_DATA_READ 

Host confirming data being read form SpiNNaker memory.

HOST_DATA_READ_ACK 

Host confirming message received to read data.

Definition at line 28 of file buffered_eieio_defs.h.

◆ buffered_operations

The different buffer operations.

Enumerator
BUFFER_OPERATION_READ 

The last operation was a read.

BUFFER_OPERATION_WRITE 

The last operation was a write.

Definition at line 50 of file buffered_eieio_defs.h.