phase_rgb_target_kernel.c File Reference

#include <TI/tivx.h>
#include <VX/vx.h>
#include <TI/tivx_target_kernel.h>
#include <vx_tutorial_kernels.h>
#include <tivx_kernels_common_utils.h>
#include <tivx_kernels_target_utils.h>

Go to the source code of this file.

Macros
#define	PHASE_RGB_IN0_IMG_IDX   (0u)
	Index of input image in parameter list.
#define	PHASE_RGB_OUT0_IMG_IDX   (1u)
	Index of output image in parameter list.
#define	PHASE_RGB_MAX_PARAMS   (2u)
	Total number of parameters for this function.

Functions
vx_status VX_CALLBACK	vxTutotrialPhaseRgb (tivx_target_kernel_instance kernel, tivx_obj_desc_t *obj_desc[], uint16_t num_params, void *priv_arg)
	Target kernel run function. More...
vx_status VX_CALLBACK	vxTutotrialPhaseRgbCreate (tivx_target_kernel_instance kernel, tivx_obj_desc_t *param_obj_desc[], uint16_t num_params, void *priv_arg)
	Target kernel create function. More...
vx_status VX_CALLBACK	vxTutotrialPhaseRgbDelete (tivx_target_kernel_instance kernel, tivx_obj_desc_t *param_obj_desc[], uint16_t num_params, void *priv_arg)
	Target kernel delete function. More...
vx_status VX_CALLBACK	vxTutotrialPhaseRgbControl (tivx_target_kernel_instance kernel, uint32_t replicated_node_idx, tivx_obj_desc_t *param_obj_desc[], uint16_t num_params, void *priv_arg)
	Target kernel control function. More...
void	vxTutorialAddTargetKernelPhaseRgb (void)
	Add target kernel to TIOVX framework. More...
void	vxTutorialRemoveTargetKernelPhaseRgb (void)
	Remove target kernel from TIOVX framework. More...

Variables
static tivx_target_kernel	phase_rgb_target_kernel = NULL
	Target kernel handle [static global].

Detailed Description

Target Kernel implementation for Phase to RGB conversion function

This file shows a sample implementation of a target kernel function.

To implement a target kernel the below top level interface functions are implemented

• vxTutorialAddTargetKernelPhaseRgb() : Registers target kernel to TIOVX target framework
• vxTutorialRemoveTargetKernelPhaseRgb() : Un-Registers target kernel from TIOVX target framework

When registering a target kernel, the following callback function are implemented and registered with the TIOVX framework

• vxTutotrialPhaseRgb() : kernel execute/run function
• vxTutotrialPhaseRgbCreate() : kernel init function
• vxTutotrialPhaseRgbDelete() : kernel deinit function
• vxTutotrialPhaseRgbControl(): kernel control function

When working with target kernel

• vxTutorialAddTargetKernelPhaseRgb() MUST be called during TIOVX target framework system init
  • This is done by using function tivxRegisterTutorialTargetKernels() in vx_tutorial_target_kernel.c
• vxTutorialRemoveTargetKernelPhaseRgb() MUST be called during TIOVX target framework system deinit
  • This is done by using function tivxUnRegisterTutorialTargetKernels() in vx_tutorial_target_kernel.c

When registering a target kernel a unique name MUST be used to register the kernel on target side and HOST side.

Follow the comments for the different functions in the file to understand how a user/target kernel is implemented.

Definition in file phase_rgb_target_kernel.c.

Function Documentation

vxTutotrialPhaseRgb()

vx_status VX_CALLBACK vxTutotrialPhaseRgb	(	tivx_target_kernel_instance	kernel,
		tivx_obj_desc_t *	obj_desc[],
		uint16_t	num_params,
		void *	priv_arg
	)

Target kernel run function.

Parameters

kernel	[in] target kernel handle
obj_desc	[in] Parameter object descriptors
num_params	[in] Number of parameter object descriptors
priv_arg	[in] kernel instance priv argument

Definition at line 119 of file phase_rgb_target_kernel.c.

vxTutotrialPhaseRgbCreate()

vx_status VX_CALLBACK vxTutotrialPhaseRgbCreate	(	tivx_target_kernel_instance	kernel,
		tivx_obj_desc_t *	param_obj_desc[],
		uint16_t	num_params,
		void *	priv_arg
	)

Target kernel create function.

Parameters

kernel	[in] target kernel handle
param_obj_desc	[in] Parameter object descriptors
num_params	[in] Number of parameter object descriptors
priv_arg	[in] kernel instance priv argument

Definition at line 228 of file phase_rgb_target_kernel.c.

vxTutotrialPhaseRgbDelete()

vx_status VX_CALLBACK vxTutotrialPhaseRgbDelete	(	tivx_target_kernel_instance	kernel,
		tivx_obj_desc_t *	param_obj_desc[],
		uint16_t	num_params,
		void *	priv_arg
	)

Target kernel delete function.

Parameters

kernel	[in] target kernel handle
param_obj_desc	[in] Parameter object descriptors
num_params	[in] Number of parameter object descriptors
priv_arg	[in] kernel instance priv argument

Definition at line 243 of file phase_rgb_target_kernel.c.

vxTutotrialPhaseRgbControl()

vx_status VX_CALLBACK vxTutotrialPhaseRgbControl	(	tivx_target_kernel_instance	kernel,
		uint32_t	replicated_node_idx,
		tivx_obj_desc_t *	param_obj_desc[],
		uint16_t	num_params,
		void *	priv_arg
	)

Target kernel control function.

Parameters

kernel	[in] target kernel handle
replicated_node_idx	[in] If node was replicated, index of replicant to send command to
param_obj_desc	[in] Parameter object descriptors
num_params	[in] Number of parameter object descriptors
priv_arg	[in] kernel instance priv argument

Definition at line 259 of file phase_rgb_target_kernel.c.

vxTutorialAddTargetKernelPhaseRgb()

void vxTutorialAddTargetKernelPhaseRgb

(

void

)

Add target kernel to TIOVX framework.

- Register target kernel to TIOVX framework

"TIVX_TUTORIAL_KERNEL_PHASE_RGB_NAME" is the name of the target kernel. See also vx_tutorial_kernels.h

This MUST match the name specified when registering the same kernel on the HOST side.

The registered target kernel handle is stored in a global variable. This is used during vxTutorialRemoveTargetKernelPhaseRgb()

  /
phase_rgb_target_kernel = tivxAddTargetKernelByName(
            TIVX_TUTORIAL_KERNEL_PHASE_RGB_NAME,
            target_name,
            vxTutotrialPhaseRgb,
            vxTutotrialPhaseRgbCreate,
            vxTutotrialPhaseRgbDelete,
            vxTutotrialPhaseRgbControl,
            NULL);

Definition at line 271 of file phase_rgb_target_kernel.c.

vxTutorialRemoveTargetKernelPhaseRgb()

void vxTutorialRemoveTargetKernelPhaseRgb

(

void

)

Remove target kernel from TIOVX framework.

- UnRegister target kernel from TIOVX framework

The target kernel handle used is the one returned during tivxAddTargetKernel()

  /
status = tivxRemoveTargetKernel(phase_rgb_target_kernel);

Definition at line 308 of file phase_rgb_target_kernel.c.