SpiNNFrontEndCommon 7.3.1
Common support code for user-facing front end systems.
Loading...
Searching...
No Matches
recording.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 The University of Manchester
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
22#ifndef _RECORDING_H_
23#define _RECORDING_H_
24
25#include <stdbool.h>
26#include <common-typedefs.h>
27#include <spin1_api.h>
28#include <buffered_eieio_defs.h>
29
31typedef uint8_t channel_index_t;
32
40bool recording_record(channel_index_t channel, void *data, size_t size_bytes);
41
44void recording_finalise(void);
45
73bool recording_initialize(void **recording_data_address, uint32_t *recording_flags);
74
76void recording_reset(void);
77
78#endif // _RECORDING_H_
Definitions for the streaming-over-EIEIO buffering protocol.
static uint32_t recording_flags
General recording flags. (Unused by this code.)
Data type definitions for SpiNNaker Neuron-modelling.
static uint32_t data[ITEMS_PER_DATA_PACKET]
bool recording_initialize(void **recording_data_address, uint32_t *recording_flags)
initialises the recording of data
Definition recording.c:161
void recording_finalise(void)
Finishes recording - should only be called if recording_flags is not 0.
Definition recording.c:139
bool recording_record(channel_index_t channel, void *data, size_t size_bytes)
records some data into a specific recording channel.
Definition recording.c:105
uint8_t channel_index_t
The type of channel indices.
Definition recording.h:31
void recording_reset(void)
resets recording to the state just after initialisation
Definition recording.c:212