gna.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation.
 *
 * Author: Sathish Kuttan <sathish.k.kuttan@intel.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __INCLUDE_GNA__
#define __INCLUDE_GNA__
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct gna_config {
#ifdef __cplusplus
        char no_empty_structs; /* technically a gcc C extension */
#endif
};
 
struct gna_model_header {
        uint32_t        labase_offset;
        uint32_t        model_size;
        uint32_t        gna_mode;
        uint32_t        layer_count;
        uint32_t        bytes_per_input;
        uint32_t        bytes_per_output;
        uint32_t        num_input_nodes;
        uint32_t        num_output_nodes;
        uint32_t        input_ptr_offset;
        uint32_t        output_ptr_offset;
        uint32_t        rw_region_size;
        uint32_t        input_scaling_factor;
        uint32_t        output_scaling_factor;
};
 
struct gna_model_info {
        struct gna_model_header *header;
        void *rw_region;
        void *ro_region;
};
 
struct gna_inference_req {
        void *model_handle;
        void *input;
        void *output;
        void *intermediate;
};
 
struct gna_inference_stats {
        uint32_t total_cycles;
        uint32_t stall_cycles;
        uint32_t cycles_per_sec;
};
 
enum gna_result {
        GNA_RESULT_INFERENCE_COMPLETE,
        GNA_RESULT_SATURATION_OCCURRED,
        GNA_RESULT_OUTPUT_BUFFER_FULL_ERROR,
        GNA_RESULT_PARAM_OUT_OF_RANGE_ERROR,
        GNA_RESULT_GENERIC_ERROR,
};
 
struct gna_inference_resp {
        enum gna_result result;
        void *output;
        size_t output_len;
        struct gna_inference_stats stats;
};
 
typedef int (*gna_callback)(struct gna_inference_resp *result);
 
typedef int (*gna_api_config)(const struct device *dev,
                              struct gna_config *cfg);
typedef int (*gna_api_register)(const struct device *dev,
                                struct gna_model_info *model,
                                void **model_handle);
typedef int (*gna_api_deregister)(const struct device *dev,
                                  void *model_handle);
typedef int (*gna_api_infer)(const struct device *dev,
                             struct gna_inference_req *req,
                             gna_callback callback);
 
struct gna_driver_api {
        gna_api_config          configure;
        gna_api_register        register_model;
        gna_api_deregister      deregister_model;
        gna_api_infer           infer;
};
 
static inline int gna_configure(const struct device *dev,
                                struct gna_config *cfg)
{
        const struct gna_driver_api *api =
                (const struct gna_driver_api *)dev->api;
 
        return api->configure(dev, cfg);
}
 
static inline int gna_register_model(const struct device *dev,
                                     struct gna_model_info *model,
                                     void **model_handle)
{
        const struct gna_driver_api *api =
                (const struct gna_driver_api *)dev->api;
 
        return api->register_model(dev, model, model_handle);
}
 
static inline int gna_deregister_model(const struct device *dev, void *model)
{
        const struct gna_driver_api *api =
                (const struct gna_driver_api *)dev->api;
 
        return api->deregister_model(dev, model);
}
 
static inline int gna_infer(const struct device *dev,
                            struct gna_inference_req *req,
                            gna_callback callback)
{
        const struct gna_driver_api *api =
                (const struct gna_driver_api *)dev->api;
 
        return api->infer(dev, req, callback);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* __INCLUDE_GNA__ */