tivx_target.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2017 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_TARGET_H_
#define TIVX_TARGET_H_


#ifdef __cplusplus
extern "C" {
#endif

#include <TI/tivx_config.h>

#define TIVX_TARGET_INST_MASK (0xFFu)

#define TIVX_TARGET_INST_SHIFT (0x0u)

#define TIVX_CPU_ID_MASK    (0xFu)

#define TIVX_CPU_ID_SHIFT   (0x8)

#define TIVX_TARGET_ID_MASK    (((uint32_t)TIVX_CPU_ID_MASK << (uint32_t)TIVX_CPU_ID_SHIFT) | \
                                ((uint32_t)TIVX_TARGET_INST_MASK << (uint32_t)TIVX_TARGET_INST_SHIFT))

#define TIVX_TARGET_ID_SHIFT    (TIVX_TARGET_INST_SHIFT)

#define TIVX_MAKE_TARGET_ID(cpu, target_inst)  (((((uint32_t)(((uint32_t)cpu) & (uint32_t)TIVX_CPU_ID_MASK)) << (uint32_t)TIVX_CPU_ID_SHIFT) |(((uint32_t)(((uint32_t)target_inst)&(uint32_t)TIVX_TARGET_INST_MASK)) << (uint32_t)TIVX_TARGET_INST_SHIFT)))

#define TIVX_GET_CPU_ID(target)                ((((uint32_t)(target) >> (uint32_t)TIVX_CPU_ID_SHIFT) & (uint32_t)TIVX_CPU_ID_MASK))

#define TIVX_GET_TARGET_INST(target)           ((uint16_t)(((uint16_t)(target) >> TIVX_TARGET_INST_SHIFT)) & TIVX_TARGET_INST_MASK)


#define TIVX_TARGET_ID_INVALID      (0xFFFFFFFFU)

#define TIVX_CPU_ID_INVALID         (0xFFFFFFFFu)


#define TIVX_TARGET_MAX_TASK_NAME   (12u)

#define TIVX_TARGET_MAX_JOB_QUEUE_DEPTH    (96u)

typedef enum _tivx_target_cmd_e {

    TIVX_CMD_NODE_CREATE  = 0x00000001u,
    TIVX_CMD_NODE_DELETE  = 0x00000002u,
    TIVX_CMD_NODE_CONTROL  = 0x00000003u,
    TIVX_CMD_NODE_USER_CALLBACK  = 0x00000004u,
    TIVX_CMD_DATA_REF_CONSUMED = 0x00000005u,
} tivx_target_cmd_e;

typedef struct _tivx_target *tivx_target;

typedef struct _tivx_target {

    vx_enum target_id;

    tivx_task task_handle;

    tivx_task_create_params_t task_params;

    tivx_queue job_queue_handle;

    uintptr_t job_queue_memory[TIVX_TARGET_MAX_JOB_QUEUE_DEPTH];

    tivx_task_main_f target_main;

    vx_bool targetExitRequest;

    vx_bool targetExitDone;
} tivx_target_t;

typedef struct _tivx_target_create_params
{
    uint8_t *task_stack_ptr;

    uint32_t task_stack_size;

    uint32_t task_core_affinity;

    uint32_t task_priority;

    char     task_name[TIVX_TARGET_MAX_TASK_NAME];

} tivx_target_create_params_t;

typedef void(*own_execute_user_kernel_f)(tivx_obj_desc_node_t *node_obj_desc, uint16_t prm_obj_desc_id[]);

typedef void(*own_target_cmd_desc_handler_f)(const tivx_obj_desc_cmd_t *cmd_obj_desc);

 void ownRegisterFunctionsForHost(void);

vx_enum ownTargetGetCpuId(vx_enum target_id);

vx_status ownTargetQueueObjDesc(vx_enum target_id, uint16_t obj_desc_id);

void ownTargetTriggerNode(uint16_t node_obj_desc_id);


void ownTargetNodeDescAcquireAllParameters(tivx_obj_desc_node_t *node_obj_desc,
            uint16_t prm_obj_desc_id[], vx_bool *is_node_blocked);


void ownTargetNodeDescAcquireAllParametersForPipeup(tivx_obj_desc_node_t *node_obj_desc,
            uint16_t prm_obj_desc_id[]);

void ownTargetNodeDescReleaseAllParameters(tivx_obj_desc_node_t *node_obj_desc, uint16_t prm_obj_desc_id[]);

void ownTargetSetDefaultCreateParams(tivx_target_create_params_t *params);

vx_status ownTargetCreate(vx_enum target_id, const tivx_target_create_params_t *params);


vx_status ownTargetDelete(vx_enum target_id);

void ownTargetInit(void);

void ownTargetDeInit(void);


void ownTargetSetTimestamp(
    const tivx_obj_desc_node_t *node_obj_desc, tivx_obj_desc_t *obj_desc[]);

#ifdef __cplusplus
}
#endif

#endif