recording.h File Reference

interface for recording data into "channels" on the SDRAM in a standard way, and storing buffers to be extracted during execution More...

#include <stdbool.h>
#include <common-typedefs.h>
#include <spin1_api.h>
#include <buffered_eieio_defs.h>

Go to the source code of this file.

Typedefs
typedef uint8_t	channel_index_t
	The type of channel indices.

Functions
bool	recording_record (channel_index_t channel, void *data, size_t size_bytes)
	records some data into a specific recording channel.
void	recording_finalise (void)
	Finishes recording - should only be called if recording_flags is not 0.
bool	recording_initialize (void **recording_data_address, uint32_t *recording_flags)
	initialises the recording of data
void	recording_reset (void)
	resets recording to the state just after initialisation

Detailed Description

interface for recording data into "channels" on the SDRAM in a standard way, and storing buffers to be extracted during execution

Definition in file recording.h.

Typedef Documentation

channel_index_t

typedef uint8_t channel_index_t

The type of channel indices.

Definition at line 31 of file recording.h.

Function Documentation

recording_record()

bool recording_record	(	channel_index_t	channel,
		void *	data,
		size_t	size_bytes
	)

records some data into a specific recording channel.

Parameters

[in]	channel	the channel to store the data into.
[in]	data	the data to store into the channel.
[in]	size_bytes	the number of bytes that this data will take up. This may be any number of bytes, not just whole words.

Returns

boolean which is True if the data has been stored in the channel, False otherwise.

Definition at line 105 of file recording.c.

recording_finalise()

void recording_finalise

(

void

)

Finishes recording - should only be called if recording_flags is not 0.

Definition at line 139 of file recording.c.

recording_initialize()

bool recording_initialize	(	void **	recording_data_address,
		uint32_t *	recording_flags
	)

initialises the recording of data

Parameters

[in,out]	recording_data_address	The start of the data about the recording, updated to point to just after the data if return True. Data is: { // number of potential recording regions uint32_t n_regions; // one of these for each region { // flag to indicate missing data uint32_t missing: 1; // size of region to be recorded uint32_t size_of_region: 31; // pointer region to be filled in (can be read after recording is // complete) uint8_t* pointer_to_address_of_region; }[n_regions] }
[out]	recording_flags	Output of flags which can be used to check if a channel is enabled for recording

Returns

True if the initialisation was successful, false otherwise

Definition at line 161 of file recording.c.

recording_reset()

void recording_reset

(

void

)

resets recording to the state just after initialisation

Definition at line 212 of file recording.c.