data_specification.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 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 _DATA_SPECIFICATION_H_
#define _DATA_SPECIFICATION_H_
 
#include <stdbool.h>
#include "common-typedefs.h"
 
typedef struct region_desc_t {
    void *pointer;
    uint32_t checksum;
    uint32_t n_words;
} region_desc_t;
 
typedef struct data_specification_metadata_t {
    uint32_t magic_number;
    uint32_t version;
    region_desc_t regions[];
} data_specification_metadata_t;
 
data_specification_metadata_t *data_specification_get_data_address(void);
 
bool data_specification_read_header(data_specification_metadata_t *ds_regions);
 
static inline void *data_specification_get_region(
        uint32_t region, data_specification_metadata_t *ds_regions) {
    return ds_regions->regions[region].pointer;
}
 
#endif