tivx_obj_desc_priv.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_PRIV_H_
#define TIVX_OBJ_DESC_PRIV_H_

#include <TI/tivx_obj_desc.h>
#include <TI/tivx_config.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_OBJ_DESC_QUEUE_MAX_BLOCKED_NODES       (8u)

#define TIVX_OBJ_DESC_QUEUE_MAX_DEPTH               (32u)

#define TIVX_CMD_MAX_OBJ_DESCS        (16u)

#define TIVX_CMD_FLAG_SEND_ACK           (0x00000001u)

#define TIVX_CMD_FLAG_IS_ACK             (0x00000002u)


#define TIVX_OBJ_DESC_DATA_REF_Q_FLAG_IS_ENABLE_REF_CONSUMED_EVENT      (0x00000001u)

#define TIVX_OBJ_DESC_DATA_REF_Q_FLAG_IS_REF_ACQUIRED                   (0x00000002u)

#define TIVX_OBJ_DESC_DATA_REF_Q_FLAG_IS_IN_DELAY                       (0x00000004u)

#define TIVX_OBJ_DESC_DATA_REF_Q_FLAG_DELAY_SLOT_AUTO_AGE               (0x00000008u)

#define TIVX_OBJ_DESC_DATA_REF_GRAPH_PARAM_ENQUEUED                     (0x00000010u)

#define TIVX_OBJ_DESC_ID_SHIFT           (12u)

#define TIVX_OBJ_DESC_ID_MASK            (0x0000FFFFu)

typedef struct _tivx_obj_desc_cmd
{
    tivx_obj_desc_t base;

    volatile uint64_t ack_event_handle;

    volatile uint32_t cmd_id;

    volatile uint16_t cmd_params_desc_id[TIVX_KERNEL_MAX_PARAMS];
    volatile uint32_t num_cmd_params;
    volatile uint32_t node_cmd_id;
    volatile int32_t replicated_node_idx;

    volatile uint32_t flags;

    volatile uint32_t dst_target_id;

    volatile uint32_t src_target_id;

    volatile uint32_t num_obj_desc;

    volatile uint16_t obj_desc_id[TIVX_CMD_MAX_OBJ_DESCS];

    volatile uint32_t cmd_status;

    volatile uint32_t timestamp_h;

    volatile uint32_t timestamp_l;

} tivx_obj_desc_cmd_t;

typedef struct _tivx_obj_desc_kernel_name
{
    tivx_obj_desc_t base;

    volatile char kernel_name[VX_MAX_KERNEL_NAME];

    volatile uint32_t num_pipeup_bufs;

} tivx_obj_desc_kernel_name_t;

typedef struct _tivx_obj_desc_queue_blocked_nodes {

    volatile uint16_t num_nodes;

    volatile uint16_t rsv[7];

    volatile uint16_t node_id[TIVX_OBJ_DESC_QUEUE_MAX_BLOCKED_NODES];

} tivx_obj_desc_queue_blocked_nodes_t;

typedef struct _tivx_obj_desc_queue
{
    tivx_obj_desc_t base;

    volatile uint16_t cur_rd;

    volatile uint16_t cur_wr;

    volatile uint16_t count;

    volatile uint16_t rsv[5];

    volatile uint16_t queue_mem[TIVX_OBJ_DESC_QUEUE_MAX_DEPTH];

    tivx_obj_desc_queue_blocked_nodes_t blocked_nodes;

} tivx_obj_desc_queue_t;

typedef struct _tivx_obj_desc_data_ref_q
{
    tivx_obj_desc_t base;

    volatile uint32_t flags;

    volatile uint16_t ref_consumed_cmd_obj_desc_id;

    volatile uint16_t acquire_q_obj_desc_id;

    volatile uint16_t release_q_obj_desc_id;

    volatile uint16_t ref_obj_desc_id;

    volatile uint16_t in_node_done_cnt;

    volatile uint16_t num_in_nodes;

    volatile uint16_t next_obj_desc_id_in_delay;

    volatile uint16_t delay_slot_index;

    volatile uint16_t delay_slots;

    volatile uint16_t rsv[1];

} tivx_obj_desc_data_ref_q_t;

typedef struct _tivx_obj_desc_graph
{
    tivx_obj_desc_t base;

    volatile uint32_t pipeline_id;

    volatile uint32_t state;

    volatile uint32_t complete_leaf_nodes;

    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;

} tivx_obj_desc_graph_t;

typedef struct _tivx_obj_desc_super_node_edge
{
    uint16_t src_node_obj_desc_id;
    uint16_t src_node_prm_idx;
    uint16_t dst_node_obj_desc_id;
    uint16_t dst_node_prm_idx;

} tivx_obj_desc_super_node_edge_t;


typedef struct _tivx_obj_desc_super_node
{
    tivx_obj_desc_t base;

    uint16_t num_nodes;

    uint16_t node_obj_desc_id[TIVX_SUPER_NODE_MAX_NODES];

    uint16_t num_edges;

    tivx_obj_desc_super_node_edge_t edge_list[TIVX_SUPER_NODE_MAX_EDGES];

} tivx_obj_desc_super_node_t;

typedef union {

    tivx_obj_desc_cmd_t cmd_union;
    tivx_obj_desc_node_t node_union;
    tivx_obj_desc_image_t image_union;
    tivx_obj_desc_remap_t remap_union;
    tivx_obj_desc_matrix_t matrix_union;
    tivx_obj_desc_lut_t lut_union;
    tivx_obj_desc_pyramid_t pyramid_union;
    tivx_obj_desc_convolution_t convolution_union;
    tivx_obj_desc_threshold_t threshold_union;
    tivx_obj_desc_distribution_t distribution_union;
    tivx_obj_desc_array_t array_union;
    tivx_obj_desc_user_data_object_t user_data_object_union;
    tivx_obj_desc_raw_image_t raw_image_union;
    tivx_obj_desc_object_array_t objarray_union;
    tivx_obj_desc_tensor_t tensor_union;
    tivx_obj_desc_scalar_t scalar_union;
    tivx_obj_desc_kernel_name_t kernel_name_union;
    tivx_obj_desc_queue_t obj_desc_queue_union;
    tivx_obj_desc_data_ref_q_t obj_desc_data_ref_q_union;
    tivx_obj_desc_graph_t obj_desc_graph_union;
    tivx_obj_desc_super_node_t super_node_union;

    uint8_t rsv[TIVX_OBJ_DESC_MAX_SHM_ENTRY_SIZE];

} tivx_obj_desc_shm_entry_t;

typedef struct {

    tivx_obj_desc_shm_entry_t *table_base;

    uint32_t num_entries;

    uint32_t last_alloc_index;

} tivx_obj_desc_table_info_t;

tivx_obj_desc_t *ownObjDescAlloc(vx_enum ref_type, vx_reference ref);

vx_status ownObjDescFree(tivx_obj_desc_t **obj_desc);


vx_status ownObjDescSend(uint32_t dst_target_id, uint16_t obj_desc_id);

tivx_obj_desc_t *ownObjDescGet(uint16_t obj_desc_id);

vx_bool ownObjDescIsValidType(const tivx_obj_desc_t *obj_desc, tivx_obj_desc_type_e obj_type);

void ownObjDescInit(void);

#ifdef __cplusplus
}
#endif

#endif