tiovx.kernel_code.KernelExportCode Class Reference

Code object used to generate custom kernel. More...

Public Member Functions
def	__init__ (self, module="ext1", core="c66", env_var='VISION_APPS_PATH', include_subpath="TI", include_filename="")
	Constructor used to create this object. More...
def	exportDiagram (self, kernel)
	Export object as C source code.
def	export (self, kernel)
	Method for generating files from kernel. More...

Detailed Description

Code object used to generate custom kernel.

Example Usage: Setting up file paths for custom kernel

Note: if leaving the optional field for env_var blank, you must set CUSTOM_KERNEL_PATH

from tiovx import *

code = KernelExportCode(Module.IMAGING, Core.C66, "CUSTOM_KERNEL_PATH")
<set up kernel parameters>
code.export(kernel)

Output files from the above parameters:

<CUSTOM_KERNEL_PATH>/DEVELOPER_TODO.txt (generated first time only for given parameters)
<CUSTOM_KERNEL_PATH>/include/TI/tivx_imaging.h (generated first time only for given parameters)
<CUSTOM_KERNEL_PATH>/include/TI/tivx_imaging_kernels.h (generated first time only for given parameters)
<CUSTOM_KERNEL_PATH>/include/TI/tivx_imaging_nodes.h (generated first time only for given parameters)

Output folder from the above parameters:

<CUSTOM_KERNEL_PATH>/imaging/

This folder contains the following:

c66/concerto.mak (generated first time only for given parameters)
c66/vx_<kernel_name>_target.c
c66/vx_kernels_imaging_target.c (generated first time only for given parameters)
c66/bam/vx_bam_<kernel_name>_target.c (if using the C66 DSP)
c66/bam/concerto.mak (generated first time only for given parameters, if using the C66 DSP)
host/concerto.mak (generated first time only for given parameters)
tivx_imaging_node_api.c (generated first time only for given parameters)
host/vx_<kernel_name>_host.c
host/vx_kernels_imaging_host.c (generated first time only for given parameters)
include/tivx_imaging_kernels.h (generated first time only for given parameters)
include/tivx_kernel_<kernel_name>.h
test/concerto.mak (generated first time only for given parameters)
test/test_main.h (generated first time only for given parameters)

Below is an example using the CUSTOM_APPLICATION_PATH

from tiovx import *

code = KernelExportCode(Module.IMAGING, Core.C66, "CUSTOM_APPLICATION_PATH")
<set up kernel parameters>
code.export(kernel)

Output files from the above parameters:

<CUSTOM_APPLICATION_PATH>/DEVELOPER_TODO.txt
<CUSTOM_APPLICATION_PATH>/concerto_inc.mak
<CUSTOM_APPLICATION_PATH>/custom_tools_path.mak
<CUSTOM_APPLICATION_PATH>/kernels/imaging/include/TI/tivx_imaging.h
<CUSTOM_APPLICATION_PATH>/kernels/imaging/include/TI/tivx_imaging_kernels.h
<CUSTOM_APPLICATION_PATH>/kernels/imaging/include/TI/tivx_imaging_nodes.h

Output folder from the above parameters:

<CUSTOM_APPLICATION_PATH>/kernels/imaging/

This folder contains the following:

c66/concerto.mak (generated first time only for given parameters)
c66/vx_<kernel_name>_target.c
c66/vx_kernels_imaging_target.c (generated first time only for given parameters)
c66/bam/vx_bam_<kernel_name>_target.c (if using the C66 DSP)
c66/bam/concerto.mak (generated first time only for given parameters, if using the C66 DSP)
host/concerto.mak (generated first time only for given parameters)
tivx_imaging_node_api.c (generated first time only for given parameters)
host/vx_<kernel_name>_host.c
host/vx_kernels_imaging_host.c (generated first time only for given parameters)
include/tivx_imaging_kernels.h (generated first time only for given parameters)
include/tivx_kernel_<kernel_name>.h
test/concerto.mak (generated first time only for given parameters)
test/test_main.h (generated first time only for given parameters)

Below is an example using the VISION_APPS_PATH

from tiovx import *

code = KernelExportCode(Module.IMAGING, Core.C66, "VISION_APPS_PATH")
<set up kernel parameters>
code.export(kernel)

Output files from the above parameters:

<VISION_APPS_PATH>/kernels/DEVELOPER_TODO.txt
<VISION_APPS_PATH>/kernels/imaging/include/TI/tivx_imaging.h
<VISION_APPS_PATH>/kernels/imaging/include/TI/tivx_imaging_kernels.h
<VISION_APPS_PATH>/kernels/imaging/include/TI/tivx_imaging_nodes.h

Output folder from the above parameters:

<VISION_APPS_PATH>/kernels/imaging/

This folder contains the following:

c66/concerto.mak (generated first time only for given parameters)
c66/vx_<kernel_name>_target.c
c66/vx_kernels_imaging_target.c (generated first time only for given parameters)
c66/bam/vx_bam_<kernel_name>_target.c (if using the C66 DSP)
c66/bam/concerto.mak (generated first time only for given parameters, if using the C66 DSP)
host/concerto.mak (generated first time only for given parameters)
tivx_imaging_node_api.c (generated first time only for given parameters)
host/vx_<kernel_name>_host.c
host/vx_kernels_imaging_host.c (generated first time only for given parameters)
include/tivx_imaging_kernels.h (generated first time only for given parameters)
include/tivx_kernel_<kernel_name>.h
test/concerto.mak (generated first time only for given parameters)
test/test_main.h (generated first time only for given parameters)

Definition at line 194 of file kernel_code.py.

Constructor & Destructor Documentation

__init__()

def tiovx.kernel_code.KernelExportCode.__init__	(		self,
			module = "ext1",
			core = "c66",
			env_var = 'VISION_APPS_PATH',
			include_subpath = "TI",
			include_filename = ""
	)

Constructor used to create this object.

Parameters

module	[in] [optional] Module name for the kernel; Default="ext1"
core	[in] [optional] Name of the core for the kernel to run on; Default="c66"
env_var	[in] [optional] Path to the directory where these should be outputted; Default="VISION_APPS_PATH"
include_subpath	[in] [optional] Company name which serves as a subpath for an include directory; Default="TI"
include_filename	[in] [optional] Variable to overwrite the include filename, otherwise include filename set to <lowercase(include_subpath)>vx_<module>; Default=""

Definition at line 202 of file kernel_code.py.

Member Function Documentation

export()

def tiovx.kernel_code.KernelExportCode.export	(		self,
			kernel
	)

Method for generating files from kernel.

Parameters

kernel

[in] Kernel to be exported to a file

Definition at line 3068 of file kernel_code.py.

---

The documentation for this class was generated from the following file:

• kernel_code.py