master/c_common/recording_8h_source.html

 /*

  * Copyright (c) 2015 The University of Manchester

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     https://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */


 #ifndef _RECORDING_H_

 #define _RECORDING_H_


 #include <stdbool.h>

 #include <common-typedefs.h>

 #include <spin1_api.h>

 #include <buffered_eieio_defs.h>


 typedef uint8_t channel_index_t;


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


 void recording_finalise(void);


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


 void recording_reset(void);


 #endif // _RECORDING_H_

buffered_eieio_defs.h
Definitions for the streaming-over-EIEIO buffering protocol.

recording_flags
static uint32_t recording_flags
General recording flags. (Unused by this code.)
Definition: chip_power_monitor.c:87

common-typedefs.h
Data type definitions for SpiNNaker Neuron-modelling.

data
static uint32_t data[ITEMS_PER_DATA_PACKET]
Definition: data_speed_up_packet_gatherer.c:183

recording_initialize
bool recording_initialize(void **recording_data_address, uint32_t *recording_flags)
initialises the recording of data
Definition: recording.c:161

recording_finalise
void recording_finalise(void)
Finishes recording - should only be called if recording_flags is not 0.
Definition: recording.c:139

recording_record
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

channel_index_t
uint8_t channel_index_t
The type of channel indices.
Definition: recording.h:31

recording_reset
void recording_reset(void)
resets recording to the state just after initialisation
Definition: recording.c:212