tivx_obj_desc.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2017-2019 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/



#ifndef TIVX_OBJ_DESC_H_
#define TIVX_OBJ_DESC_H_

#include <TI/tivx_mem.h>
#include <TI/tivx_config.h>
#include <TI/tivx_ext_raw_image.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_OBJ_DESC_MAX_SHM_ENTRY_SIZE        (1024U)

#define TIVX_IMAGE_MAX_PLANES   (3u)

#define TIVX_CONTEXT_MAX_TENSOR_DIMS (4)

#define TIVX_REF_FLAG_LOG_RT_TRACE            (0x00000001u)

#define TIVX_REF_FLAG_IS_INVALID              (0x00000002u)

#define TIVX_NODE_FLAG_IS_REPLICATED     (0x00000001u)

#define TIVX_NODE_FLAG_IS_EXECUTED       (0x00000002u)

#define TIVX_NODE_FLAG_IS_USER_CALLBACK  (0x00000004u)

#define TIVX_NODE_FLAG_IS_TARGET_KERNEL  (0x00000008u)

#define TIVX_NODE_FLAG_IS_SUPERNODE  (0x00000010u)

#define TIVX_NODE_OBJ_DESC_STATE_IDLE                    (0x0u)

#define TIVX_NODE_OBJ_DESC_STATE_BLOCKED                  (0x1u)


#define TIVX_OBJ_DESC_MAX_HOST_PORT_ID_CPU                (16u)

typedef enum _tivx_obj_desc_type_e {

    TIVX_OBJ_DESC_IMAGE         = 0x0,

    TIVX_OBJ_DESC_SCALAR        = 0x1,

    TIVX_OBJ_DESC_REMAP         = 0x2,

    TIVX_OBJ_DESC_NODE          = 0x3,

    TIVX_OBJ_DESC_CMD           = 0x4,

    TIVX_OBJ_DESC_MATRIX        = 0x5,

    TIVX_OBJ_DESC_LUT           = 0x6,

    TIVX_OBJ_DESC_CONVOLUTION   = 0x7,

    TIVX_OBJ_DESC_DISTRIBUTION  = 0x8,

    TIVX_OBJ_DESC_THRESHOLD     = 0x9,

    TIVX_OBJ_DESC_ARRAY         = 0xA,

    TIVX_OBJ_DESC_PYRAMID       = 0xB,

    TIVX_OBJ_DESC_OBJARRAY      = 0xC,

    TIVX_OBJ_DESC_KERNEL_NAME   = 0xD,

    TIVX_OBJ_DESC_QUEUE         = 0xE,

    TIVX_OBJ_DESC_DATA_REF_Q    = 0xF,

    TIVX_OBJ_DESC_GRAPH         = 0x10,

    TIVX_OBJ_DESC_TENSOR        = 0x11,

    TIVX_OBJ_DESC_USER_DATA_OBJECT = 0x12,

    TIVX_OBJ_DESC_RAW_IMAGE     = 0x13,

    TIVX_OBJ_DESC_SUPER_NODE   = 0x14,

    TIVX_OBJ_DESC_INVALID       = 0xFFFFu

} tivx_obj_desc_type_e;

typedef enum _tivx_image_create_type_e
{
    TIVX_IMAGE_NORMAL,
    TIVX_IMAGE_UNIFORM,
    TIVX_IMAGE_VIRTUAL,
    TIVX_IMAGE_FROM_HANDLE,
    TIVX_IMAGE_FROM_ROI,
    TIVX_IMAGE_FROM_CHANNEL

} tivx_image_create_type_e;

typedef struct _tivx_remap_point {

    vx_float32 src_x;
    vx_float32 src_y;

} tivx_remap_point_t;

typedef struct _tivx_obj_desc_t {

    volatile uint16_t obj_desc_id;

    volatile uint16_t type;

    volatile uint16_t scope_obj_desc_id;

    volatile uint16_t in_node_done_cnt;

    volatile uint64_t host_ref;

    volatile uint32_t flags;

    volatile uint32_t element_idx;

    volatile uint64_t timestamp;

    volatile uint32_t host_cpu_id;

    volatile uint32_t rsv0;

    volatile uint16_t host_port_id[TIVX_OBJ_DESC_MAX_HOST_PORT_ID_CPU];


} tivx_obj_desc_t;

typedef struct _tivx_obj_desc_node
{
    tivx_obj_desc_t base;

    volatile uint32_t flags;

    volatile uint32_t kernel_id;

    volatile uint32_t kernel_name_obj_desc_id;

    volatile uint32_t target_id;

    volatile uint32_t node_complete_cmd_obj_desc_id;

    volatile uint32_t target_kernel_index[TIVX_NODE_MAX_REPLICATE];

    volatile uint32_t exe_status;

    volatile uint32_t exe_time_beg_h;

    volatile uint32_t exe_time_beg_l;

    volatile uint32_t exe_time_end_h;

    volatile uint32_t exe_time_end_l;

    volatile uint32_t num_params;

    volatile uint32_t num_out_nodes;

    volatile uint32_t num_in_nodes;

    vx_border_t border_mode;

    volatile uint32_t is_prm_replicated;

    volatile uint32_t num_of_replicas;

    volatile uint16_t data_id[TIVX_KERNEL_MAX_PARAMS];

    volatile uint16_t data_ref_q_id[TIVX_KERNEL_MAX_PARAMS];

    volatile uint16_t out_node_id[TIVX_NODE_MAX_OUT_NODES];

    volatile uint16_t in_node_id[TIVX_NODE_MAX_IN_NODES];

    volatile uint16_t state;

    volatile uint16_t blocked_node_id;

    volatile uint16_t pipeline_id;

    volatile uint16_t prev_pipe_node_id;

    volatile uint32_t is_prm_input;

    volatile uint32_t is_prm_data_ref_q;

    volatile uint32_t is_prm_array_element;

    volatile uint32_t source_state;

    volatile uint32_t num_pipeup_bufs;

    volatile uint32_t pipeup_buf_idx;

    volatile uint32_t block_width;

    volatile uint32_t block_height;

} tivx_obj_desc_node_t;

typedef struct _tivx_obj_desc_image
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr[TIVX_IMAGE_MAX_PLANES];
    volatile uint32_t width;
    volatile uint32_t height;
    volatile uint32_t format;
    volatile uint32_t planes;
    volatile uint32_t color_space;
    volatile uint32_t color_range;
    volatile uint32_t mem_size[TIVX_IMAGE_MAX_PLANES];
    volatile uint32_t rsv[1];
    volatile uint32_t uniform_image_pixel_value;
    volatile uint32_t create_type;
    vx_imagepatch_addressing_t imagepatch_addr[TIVX_IMAGE_MAX_PLANES];
    vx_rectangle_t valid_roi;
} tivx_obj_desc_image_t;


typedef struct _tivx_obj_desc_remap
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t src_width;
    volatile uint32_t src_height;
    volatile uint32_t dst_width;
    volatile uint32_t dst_height;
    volatile uint32_t mem_size;
} tivx_obj_desc_remap_t;

typedef struct _tivx_obj_desc_matrix
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t rows;
    volatile uint32_t columns;
    volatile uint32_t origin_x;
    volatile uint32_t origin_y;
    volatile vx_enum pattern;
    volatile uint32_t mem_size;
    volatile vx_enum data_type;

} tivx_obj_desc_matrix_t;

typedef struct _tivx_obj_desc_lut
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile vx_enum item_type;
    volatile vx_uint32 item_size;
    volatile vx_uint32 num_items;
    volatile uint32_t mem_size;

} tivx_obj_desc_lut_t;

typedef struct _tivx_obj_desc_pyramid
{
    tivx_obj_desc_t base;
    volatile vx_uint32 num_levels;
    volatile vx_uint32 width;
    volatile uint32_t height;
    volatile vx_float32 scale;
    volatile vx_df_image format;
    volatile uint16_t obj_desc_id[TIVX_PYRAMID_MAX_LEVEL_OBJECTS];
} tivx_obj_desc_pyramid_t;

typedef struct _tivx_obj_desc_convolution
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t rows;
    volatile uint32_t columns;
    volatile uint32_t scale;
    volatile uint32_t mem_size;
} tivx_obj_desc_convolution_t;

typedef struct _tivx_obj_desc_threshold
{
    tivx_obj_desc_t base;
    volatile vx_enum type;
    volatile int32_t value;
    volatile int32_t upper;
    volatile int32_t lower;
    volatile int32_t true_value;
    volatile int32_t false_value;
    volatile vx_enum data_type;
} tivx_obj_desc_threshold_t;

typedef struct _tivx_obj_desc_distribution
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t num_bins;
    volatile uint32_t offset;
    volatile uint32_t range;
    volatile uint32_t num_win;
    volatile uint32_t mem_size;

} tivx_obj_desc_distribution_t;

typedef struct _tivx_obj_desc_array
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile vx_enum item_type;
    volatile uint32_t item_size;
    volatile uint32_t num_items;
    volatile uint32_t capacity;
    volatile uint32_t mem_size;

} tivx_obj_desc_array_t;

typedef struct _tivx_obj_desc_user_data_object
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t mem_size;
    volatile uint32_t valid_mem_size;
    volatile vx_char type_name[VX_MAX_REFERENCE_NAME];

} tivx_obj_desc_user_data_object_t;

typedef struct _tivx_obj_desc_raw_image
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    tivx_shared_mem_ptr_t img_ptr[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    tivx_shared_mem_ptr_t meta_before_ptr[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    tivx_shared_mem_ptr_t meta_after_ptr[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    tivx_raw_image_create_params_t params;
    volatile uint32_t mem_size[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    volatile uint32_t create_type;
    vx_imagepatch_addressing_t imagepatch_addr[TIVX_RAW_IMAGE_MAX_EXPOSURES];
    vx_rectangle_t valid_roi;

} tivx_obj_desc_raw_image_t;

typedef struct _tivx_obj_desc_object_array
{
    tivx_obj_desc_t base;
    volatile vx_enum item_type;
    volatile uint32_t num_items;
    volatile uint16_t obj_desc_id[TIVX_OBJECT_ARRAY_MAX_ITEMS];

} tivx_obj_desc_object_array_t;

typedef struct _tivx_obj_desc_scalar
{
    tivx_obj_desc_t base;
    volatile uint32_t  data_type;
    volatile uint32_t rsv;

    union {
        volatile vx_char   chr;
        volatile vx_int8   s08;
        volatile vx_uint8  u08;
        volatile vx_int16  s16;
        volatile vx_uint16 u16;
        volatile vx_int32  s32;
        volatile vx_uint32 u32;
        volatile vx_int64  s64;
        volatile vx_uint64  u64;
#if defined(EXPERIMENTAL_PLATFORM_SUPPORTS_16_FLOAT)

        volatile vx_float16 f16;
#endif

        volatile vx_float32 f32;
        volatile vx_float64 f64;
        volatile vx_df_image  fcc;
        volatile vx_enum    enm;
        volatile vx_size    size;
        volatile vx_bool    boolean;
    } data;

} tivx_obj_desc_scalar_t;

typedef struct _tivx_obj_desc_tensor
{
    tivx_obj_desc_t base;
    tivx_shared_mem_ptr_t mem_ptr;
    volatile uint32_t number_of_dimensions;
    volatile uint32_t data_type;
    volatile uint32_t fixed_point_position;
    volatile uint32_t scaling_divisor;
    volatile uint32_t scaling_divisor_fixed_point_position;
    volatile uint32_t dimensions[TIVX_CONTEXT_MAX_TENSOR_DIMS];
    volatile uint32_t stride[TIVX_CONTEXT_MAX_TENSOR_DIMS];
    volatile uint32_t mem_size;
} tivx_obj_desc_tensor_t;

void tivxGetObjDescList(volatile uint16_t obj_desc_id[],
    tivx_obj_desc_t *obj_desc[], uint32_t num_desc_id);

tivx_obj_desc_t *tivxGetObjDescElement(tivx_obj_desc_t *obj_desc, uint16_t elem_idx);

void tivx_obj_desc_strncpy(volatile void *dst, volatile void *src, uint32_t size);

void tivx_obj_desc_memcpy(volatile void *dst, volatile void *src, uint32_t size);

void tivx_obj_desc_memset(volatile void *dst, uint8_t val, uint32_t size);


int32_t tivx_obj_desc_strncmp(volatile void *dst, volatile void *src, uint32_t size);

int32_t tivx_obj_desc_strncmp_delim(volatile void *dst, volatile void *src, uint32_t size, char delim);

#ifdef __cplusplus
}
#endif

#endif