api/spec/ml_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2021-2025 Nokia
 * Copyright (c) 2021 Marvell
 */
 
#ifndef ODP_API_SPEC_ML_TYPES_H_
#define ODP_API_SPEC_ML_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ODP_ML_ENGINE_ANY 0
 
#define ODP_ML_MAX_DIMS      8
 
#define ODP_ML_DIM_DYNAMIC   0
 
#define ODP_ML_COMPL_MODE_SYNC 0x1u
 
#define ODP_ML_COMPL_MODE_POLL 0x2u
 
#define ODP_ML_COMPL_MODE_EVENT 0x4u
 
typedef uint32_t odp_ml_compl_mode_t;
 
typedef struct odp_ml_compl_pool_capability_t {
    uint32_t max_pools;
 
    uint32_t max_num;
 
    uint32_t max_uarea_size;
 
    odp_bool_t uarea_persistence;
 
    uint32_t max_cache_size;
 
    uint32_t min_cache_size;
 
} odp_ml_compl_pool_capability_t;
 
typedef struct odp_ml_compl_pool_param_t {
    uint32_t num;
 
    uint32_t uarea_size;
 
    struct {
        void (*init_fn)(void *uarea, uint32_t size, void *args, uint32_t index);
 
        void *args;
 
    } uarea_init;
 
    uint32_t cache_size;
 
} odp_ml_compl_pool_param_t;
 
typedef struct odp_ml_capability_t {
    uint32_t max_models;
 
    uint32_t max_models_loaded;
 
    uint64_t max_model_size;
 
    uint32_t max_compl_id;
 
    uint32_t max_inputs;
 
    uint32_t max_outputs;
 
    uint32_t max_segs_per_input;
 
    uint32_t max_segs_per_output;
 
    uint32_t min_input_align;
 
    uint32_t min_output_align;
 
    odp_bool_t packed_input_data;
 
    odp_bool_t packed_output_data;
 
    struct {
        odp_ml_compl_mode_t compl_mode_mask;
 
        odp_bool_t compl_queue_plain;
 
        odp_bool_t compl_queue_sched;
 
    } load;
 
    struct {
        odp_ml_compl_mode_t compl_mode_mask;
 
        odp_bool_t compl_queue_plain;
 
        odp_bool_t compl_queue_sched;
 
    } run;
 
    odp_ml_compl_pool_capability_t pool;
 
} odp_ml_capability_t;
 
typedef struct odp_ml_config_t {
    uint32_t engine_id;
 
    uint32_t max_models_created;
 
    uint32_t max_models_loaded;
 
    uint64_t max_model_size;
 
    odp_ml_compl_mode_t load_mode_mask;
 
    odp_ml_compl_mode_t run_mode_mask;
 
} odp_ml_config_t;
 
typedef enum {
    ODP_ML_DATA_TYPE_NONE = 0,
 
    ODP_ML_DATA_TYPE_INT8,
 
    ODP_ML_DATA_TYPE_UINT8,
 
    ODP_ML_DATA_TYPE_INT16,
 
    ODP_ML_DATA_TYPE_UINT16,
 
    ODP_ML_DATA_TYPE_INT24,
 
    ODP_ML_DATA_TYPE_UINT24,
 
    ODP_ML_DATA_TYPE_INT32,
 
    ODP_ML_DATA_TYPE_UINT32,
 
    ODP_ML_DATA_TYPE_INT64,
 
    ODP_ML_DATA_TYPE_UINT64,
 
    ODP_ML_DATA_TYPE_FP16,
 
    ODP_ML_DATA_TYPE_BFP16,
 
    ODP_ML_DATA_TYPE_FP32,
 
    ODP_ML_DATA_TYPE_FP64,
 
} odp_ml_data_type_t;
 
typedef enum {
    ODP_ML_SHAPE_NONE = 0,
 
    ODP_ML_SHAPE_STATIC,
 
    ODP_ML_SHAPE_BATCH,
 
} odp_ml_shape_type_t;
 
typedef struct odp_ml_shape_info_t {
    odp_ml_shape_type_t type;
 
    uint32_t num_dim;
 
    uint32_t dim[ODP_ML_MAX_DIMS];
 
    uint32_t dim_min[ODP_ML_MAX_DIMS];
 
    uint32_t dim_max[ODP_ML_MAX_DIMS];
 
    char dim_name[ODP_ML_MAX_DIMS][ODP_ML_SHAPE_NAME_LEN];
 
} odp_ml_shape_info_t;
 
typedef struct odp_ml_quant_param_t {
    odp_ml_data_type_t type;
 
    float scale_fp32;
 
    int32_t zerop_i32;
 
} odp_ml_quant_param_t;
 
typedef struct odp_ml_quant_info_t {
    odp_ml_quant_param_t common;
 
} odp_ml_quant_info_t;
 
typedef struct odp_ml_input_info_t {
    char name[ODP_ML_MODEL_IO_NAME_LEN];
 
    odp_ml_data_type_t data_type;
 
    uint32_t data_type_size;
 
    odp_ml_shape_info_t shape;
 
    odp_ml_quant_info_t quant_info;
 
} odp_ml_input_info_t;
 
typedef struct odp_ml_output_info_t {
    char name[ODP_ML_MODEL_IO_NAME_LEN];
 
    odp_ml_data_type_t data_type;
 
    uint32_t data_type_size;
 
    odp_ml_shape_info_t shape;
 
    odp_ml_quant_info_t quant_info;
 
} odp_ml_output_info_t;
 
typedef struct odp_ml_model_info_t {
    char name[ODP_ML_MODEL_NAME_LEN];
 
    uint64_t model_version;
 
    uint64_t interface_version;
 
    uint32_t engine_id;
 
    uint32_t index;
 
    uint32_t num_inputs;
 
    uint32_t num_outputs;
 
    union {
        struct {
            uint32_t input_quant_info  : 1;
 
            uint32_t output_quant_info : 1;
 
        };
 
        uint32_t all;
 
    } aux;
 
} odp_ml_model_info_t;
 
typedef struct odp_ml_data_format_t {
    odp_ml_data_type_t data_type;
 
    uint32_t data_type_size;
 
    odp_ml_shape_info_t shape;
 
} odp_ml_data_format_t;
 
typedef struct odp_ml_model_param_t {
    uint32_t engine_id;
 
    void *model;
 
    uint64_t size;
 
    uint32_t max_compl_id;
 
    odp_bool_t extra_stat_enable;
 
    struct {
        uint32_t num_inputs;
 
        uint32_t num_outputs;
 
        const odp_ml_data_format_t *input_format;
 
        const odp_ml_data_format_t *output_format;
 
    } extra_info;
 
    const odp_ml_model_extra_param_t *extra_param;
 
} odp_ml_model_param_t;
 
typedef struct odp_ml_run_result_t {
    uint64_t error_code;
 
    void *user_ptr;
 
} odp_ml_run_result_t;
 
typedef struct odp_ml_load_result_t {
    uint64_t error_code;
 
    void *user_ptr;
 
} odp_ml_load_result_t;
 
typedef struct odp_ml_compl_param_t {
    odp_ml_compl_mode_t mode;
 
    odp_event_t event;
 
    odp_queue_t queue;
 
    uint32_t compl_id;
 
    void *user_ptr;
 
} odp_ml_compl_param_t;
 
typedef struct odp_ml_data_seg_t {
    void *addr;
 
    uint64_t size;
 
} odp_ml_data_seg_t;
 
typedef struct odp_ml_data_t {
    uint32_t num_input_seg;
 
    uint32_t num_output_seg;
 
    odp_ml_data_seg_t *input_seg;
 
    odp_ml_data_seg_t *output_seg;
 
} odp_ml_data_t;
 
typedef struct odp_ml_run_param_t {
    uint32_t batch_size;
 
    odp_ml_run_result_t *result;
 
} odp_ml_run_param_t;
 
typedef struct odp_ml_extra_stat_info_t {
    char name[ODP_ML_EXTRA_STAT_NAME_LEN];
 
} odp_ml_extra_stat_info_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif