rknn-toolkit2-v2.1.0-2024-08-08
/
rknpu2
/examples
/3rdparty
/opencl
/libopencl-stub
/include
/CL
/cl_ext.h
/******************************************************************************* | |
* Copyright (c) 2008-2020 The Khronos Group Inc. | |
* | |
* Licensed under the Apache License, Version 2.0 (the "License"); | |
* you may not use this file except in compliance with the License. | |
* You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, software | |
* distributed under the License is distributed on an "AS IS" BASIS, | |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
* See the License for the specific language governing permissions and | |
* limitations under the License. | |
******************************************************************************/ | |
/* cl_ext.h contains OpenCL extensions which don't have external */ | |
/* (OpenGL, D3D) dependencies. */ | |
extern "C" { | |
/* cl_khr_fp64 extension - no extension #define since it has no functions */ | |
/* CL_DEVICE_DOUBLE_FP_CONFIG is defined in CL.h for OpenCL >= 120 */ | |
/* cl_khr_fp16 extension - no extension #define since it has no functions */ | |
/* Memory object destruction | |
* | |
* Apple extension for use to manage externally allocated buffers used with cl_mem objects with CL_MEM_USE_HOST_PTR | |
* | |
* Registers a user callback function that will be called when the memory object is deleted and its resources | |
* freed. Each call to clSetMemObjectCallbackFn registers the specified user callback function on a callback | |
* stack associated with memobj. The registered user callback functions are called in the reverse order in | |
* which they were registered. The user callback functions are called and then the memory object is deleted | |
* and its resources freed. This provides a mechanism for the application (and libraries) using memobj to be | |
* notified when the memory referenced by host_ptr, specified when the memory object is created and used as | |
* the storage bits for the memory object, can be reused or freed. | |
* | |
* The application may not call CL api's with the cl_mem object passed to the pfn_notify. | |
* | |
* Please check for the "cl_APPLE_SetMemObjectDestructor" extension using clGetDeviceInfo(CL_DEVICE_EXTENSIONS) | |
* before using. | |
*/ | |
cl_int CL_API_ENTRY clSetMemObjectDestructorAPPLE( cl_mem memobj, | |
void (* pfn_notify)(cl_mem memobj, void * user_data), | |
void * user_data) CL_EXT_SUFFIX__VERSION_1_0; | |
/* Context Logging Functions | |
* | |
* The next three convenience functions are intended to be used as the pfn_notify parameter to clCreateContext(). | |
* Please check for the "cl_APPLE_ContextLoggingFunctions" extension using clGetDeviceInfo(CL_DEVICE_EXTENSIONS) | |
* before using. | |
* | |
* clLogMessagesToSystemLog forwards on all log messages to the Apple System Logger | |
*/ | |
extern void CL_API_ENTRY clLogMessagesToSystemLogAPPLE( const char * errstr, | |
const void * private_info, | |
size_t cb, | |
void * user_data) CL_EXT_SUFFIX__VERSION_1_0; | |
/* clLogMessagesToStdout sends all log messages to the file descriptor stdout */ | |
extern void CL_API_ENTRY clLogMessagesToStdoutAPPLE( const char * errstr, | |
const void * private_info, | |
size_t cb, | |
void * user_data) CL_EXT_SUFFIX__VERSION_1_0; | |
/* clLogMessagesToStderr sends all log messages to the file descriptor stderr */ | |
extern void CL_API_ENTRY clLogMessagesToStderrAPPLE( const char * errstr, | |
const void * private_info, | |
size_t cb, | |
void * user_data) CL_EXT_SUFFIX__VERSION_1_0; | |
/************************ | |
* cl_khr_icd extension * | |
************************/ | |
/* cl_platform_info */ | |
/* Additional Error Codes */ | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clIcdGetPlatformIDsKHR(cl_uint num_entries, | |
cl_platform_id * platforms, | |
cl_uint * num_platforms); | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL *clIcdGetPlatformIDsKHR_fn)(cl_uint num_entries, | |
cl_platform_id * platforms, | |
cl_uint * num_platforms); | |
/******************************* | |
* cl_khr_il_program extension * | |
*******************************/ | |
/* New property to clGetDeviceInfo for retrieving supported intermediate | |
* languages | |
*/ | |
/* New property to clGetProgramInfo for retrieving for retrieving the IL of a | |
* program | |
*/ | |
extern CL_API_ENTRY cl_program CL_API_CALL | |
clCreateProgramWithILKHR(cl_context context, | |
const void * il, | |
size_t length, | |
cl_int * errcode_ret); | |
typedef CL_API_ENTRY cl_program | |
(CL_API_CALL *clCreateProgramWithILKHR_fn)(cl_context context, | |
const void * il, | |
size_t length, | |
cl_int * errcode_ret) CL_EXT_SUFFIX__VERSION_1_2; | |
/* Extension: cl_khr_image2d_from_buffer | |
* | |
* This extension allows a 2D image to be created from a cl_mem buffer without | |
* a copy. The type associated with a 2D image created from a buffer in an | |
* OpenCL program is image2d_t. Both the sampler and sampler-less read_image | |
* built-in functions are supported for 2D images and 2D images created from | |
* a buffer. Similarly, the write_image built-ins are also supported for 2D | |
* images created from a buffer. | |
* | |
* When the 2D image from buffer is created, the client must specify the | |
* width, height, image format (i.e. channel order and channel data type) | |
* and optionally the row pitch. | |
* | |
* The pitch specified must be a multiple of | |
* CL_DEVICE_IMAGE_PITCH_ALIGNMENT_KHR pixels. | |
* The base address of the buffer must be aligned to | |
* CL_DEVICE_IMAGE_BASE_ADDRESS_ALIGNMENT_KHR pixels. | |
*/ | |
/************************************** | |
* cl_khr_initialize_memory extension * | |
**************************************/ | |
/************************************** | |
* cl_khr_terminate_context extension * | |
**************************************/ | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clTerminateContextKHR(cl_context context) CL_EXT_SUFFIX__VERSION_1_2; | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL *clTerminateContextKHR_fn)(cl_context context) CL_EXT_SUFFIX__VERSION_1_2; | |
/* | |
* Extension: cl_khr_spir | |
* | |
* This extension adds support to create an OpenCL program object from a | |
* Standard Portable Intermediate Representation (SPIR) instance | |
*/ | |
/***************************************** | |
* cl_khr_create_command_queue extension * | |
*****************************************/ | |
typedef cl_properties cl_queue_properties_khr; | |
extern CL_API_ENTRY cl_command_queue CL_API_CALL | |
clCreateCommandQueueWithPropertiesKHR(cl_context context, | |
cl_device_id device, | |
const cl_queue_properties_khr* properties, | |
cl_int* errcode_ret) CL_EXT_SUFFIX__VERSION_1_2; | |
typedef CL_API_ENTRY cl_command_queue | |
(CL_API_CALL *clCreateCommandQueueWithPropertiesKHR_fn)(cl_context context, | |
cl_device_id device, | |
const cl_queue_properties_khr* properties, | |
cl_int* errcode_ret) CL_EXT_SUFFIX__VERSION_1_2; | |
/****************************************** | |
* cl_nv_device_attribute_query extension * | |
******************************************/ | |
/* cl_nv_device_attribute_query extension - no extension #define since it has no functions */ | |
/********************************* | |
* cl_amd_device_attribute_query * | |
*********************************/ | |
/********************************* | |
* cl_arm_printf extension | |
*********************************/ | |
/*********************************** | |
* cl_ext_device_fission extension | |
***********************************/ | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clReleaseDeviceEXT(cl_device_id device) CL_EXT_SUFFIX__VERSION_1_1; | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL *clReleaseDeviceEXT_fn)(cl_device_id device) CL_EXT_SUFFIX__VERSION_1_1; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clRetainDeviceEXT(cl_device_id device) CL_EXT_SUFFIX__VERSION_1_1; | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL *clRetainDeviceEXT_fn)(cl_device_id device) CL_EXT_SUFFIX__VERSION_1_1; | |
typedef cl_ulong cl_device_partition_property_ext; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clCreateSubDevicesEXT(cl_device_id in_device, | |
const cl_device_partition_property_ext * properties, | |
cl_uint num_entries, | |
cl_device_id * out_devices, | |
cl_uint * num_devices) CL_EXT_SUFFIX__VERSION_1_1; | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL * clCreateSubDevicesEXT_fn)(cl_device_id in_device, | |
const cl_device_partition_property_ext * properties, | |
cl_uint num_entries, | |
cl_device_id * out_devices, | |
cl_uint * num_devices) CL_EXT_SUFFIX__VERSION_1_1; | |
/* cl_device_partition_property_ext */ | |
/* clDeviceGetInfo selectors */ | |
/* error codes */ | |
/* CL_AFFINITY_DOMAINs */ | |
/* cl_device_partition_property_ext list terminators */ | |
/*********************************** | |
* cl_ext_migrate_memobject extension definitions | |
***********************************/ | |
typedef cl_bitfield cl_mem_migration_flags_ext; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueMigrateMemObjectEXT(cl_command_queue command_queue, | |
cl_uint num_mem_objects, | |
const cl_mem * mem_objects, | |
cl_mem_migration_flags_ext flags, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event); | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL *clEnqueueMigrateMemObjectEXT_fn)(cl_command_queue command_queue, | |
cl_uint num_mem_objects, | |
const cl_mem * mem_objects, | |
cl_mem_migration_flags_ext flags, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event); | |
/********************************* | |
* cl_qcom_ext_host_ptr extension | |
*********************************/ | |
typedef cl_uint cl_image_pitch_info_qcom; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clGetDeviceImageInfoQCOM(cl_device_id device, | |
size_t image_width, | |
size_t image_height, | |
const cl_image_format *image_format, | |
cl_image_pitch_info_qcom param_name, | |
size_t param_value_size, | |
void *param_value, | |
size_t *param_value_size_ret); | |
typedef struct _cl_mem_ext_host_ptr | |
{ | |
/* Type of external memory allocation. */ | |
/* Legal values will be defined in layered extensions. */ | |
cl_uint allocation_type; | |
/* Host cache policy for this external memory allocation. */ | |
cl_uint host_cache_policy; | |
} cl_mem_ext_host_ptr; | |
/******************************************* | |
* cl_qcom_ext_host_ptr_iocoherent extension | |
********************************************/ | |
/* Cache policy specifying io-coherence */ | |
/********************************* | |
* cl_qcom_ion_host_ptr extension | |
*********************************/ | |
typedef struct _cl_mem_ion_host_ptr | |
{ | |
/* Type of external memory allocation. */ | |
/* Must be CL_MEM_ION_HOST_PTR_QCOM for ION allocations. */ | |
cl_mem_ext_host_ptr ext_host_ptr; | |
/* ION file descriptor */ | |
int ion_filedesc; | |
/* Host pointer to the ION allocated memory */ | |
void* ion_hostptr; | |
} cl_mem_ion_host_ptr; | |
/********************************* | |
* cl_qcom_android_native_buffer_host_ptr extension | |
*********************************/ | |
typedef struct _cl_mem_android_native_buffer_host_ptr | |
{ | |
/* Type of external memory allocation. */ | |
/* Must be CL_MEM_ANDROID_NATIVE_BUFFER_HOST_PTR_QCOM for Android native buffers. */ | |
cl_mem_ext_host_ptr ext_host_ptr; | |
/* Virtual pointer to the android native buffer */ | |
void* anb_ptr; | |
} cl_mem_android_native_buffer_host_ptr; | |
/****************************************** | |
* cl_img_yuv_image extension * | |
******************************************/ | |
/* Image formats used in clCreateImage */ | |
/****************************************** | |
* cl_img_cached_allocations extension * | |
******************************************/ | |
/* Flag values used by clCreateBuffer */ | |
/****************************************** | |
* cl_img_use_gralloc_ptr extension * | |
******************************************/ | |
/* Flag values used by clCreateBuffer */ | |
/* To be used by clGetEventInfo: */ | |
/* Error code from clEnqueueReleaseGrallocObjectsIMG */ | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueAcquireGrallocObjectsIMG(cl_command_queue command_queue, | |
cl_uint num_objects, | |
const cl_mem * mem_objects, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueReleaseGrallocObjectsIMG(cl_command_queue command_queue, | |
cl_uint num_objects, | |
const cl_mem * mem_objects, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
/********************************* | |
* cl_khr_subgroups extension | |
*********************************/ | |
/* For OpenCL 2.1 and newer, cl_kernel_sub_group_info is declared in CL.h. | |
In hindsight, there should have been a khr suffix on this type for | |
the extension, but keeping it un-suffixed to maintain backwards | |
compatibility. */ | |
typedef cl_uint cl_kernel_sub_group_info; | |
/* cl_kernel_sub_group_info */ | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clGetKernelSubGroupInfoKHR(cl_kernel in_kernel, | |
cl_device_id in_device, | |
cl_kernel_sub_group_info param_name, | |
size_t input_value_size, | |
const void * input_value, | |
size_t param_value_size, | |
void * param_value, | |
size_t * param_value_size_ret) CL_EXT_SUFFIX__VERSION_2_0_DEPRECATED; | |
typedef CL_API_ENTRY cl_int | |
(CL_API_CALL * clGetKernelSubGroupInfoKHR_fn)(cl_kernel in_kernel, | |
cl_device_id in_device, | |
cl_kernel_sub_group_info param_name, | |
size_t input_value_size, | |
const void * input_value, | |
size_t param_value_size, | |
void * param_value, | |
size_t * param_value_size_ret) CL_EXT_SUFFIX__VERSION_2_0_DEPRECATED; | |
/********************************* | |
* cl_khr_mipmap_image extension | |
*********************************/ | |
/* cl_sampler_properties */ | |
/********************************* | |
* cl_khr_priority_hints extension | |
*********************************/ | |
/* This extension define is for backwards compatibility. | |
It shouldn't be required since this extension has no new functions. */ | |
typedef cl_uint cl_queue_priority_khr; | |
/* cl_command_queue_properties */ | |
/* cl_queue_priority_khr */ | |
/********************************* | |
* cl_khr_throttle_hints extension | |
*********************************/ | |
/* This extension define is for backwards compatibility. | |
It shouldn't be required since this extension has no new functions. */ | |
typedef cl_uint cl_queue_throttle_khr; | |
/* cl_command_queue_properties */ | |
/* cl_queue_throttle_khr */ | |
/********************************* | |
* cl_khr_subgroup_named_barrier | |
*********************************/ | |
/* This extension define is for backwards compatibility. | |
It shouldn't be required since this extension has no new functions. */ | |
/* cl_device_info */ | |
/********************************* | |
* cl_khr_extended_versioning | |
*********************************/ | |
typedef cl_uint cl_version_khr; | |
typedef struct _cl_name_version_khr | |
{ | |
cl_version_khr version; | |
char name[CL_NAME_VERSION_MAX_NAME_SIZE_KHR]; | |
} cl_name_version_khr; | |
/* cl_platform_info */ | |
/* cl_device_info */ | |
/********************************* | |
* cl_khr_device_uuid extension | |
*********************************/ | |
/********************************** | |
* cl_arm_import_memory extension * | |
**********************************/ | |
typedef intptr_t cl_import_properties_arm; | |
/* Default and valid proporties name for cl_arm_import_memory */ | |
/* Host process memory type default value for CL_IMPORT_TYPE_ARM property */ | |
/* DMA BUF memory type value for CL_IMPORT_TYPE_ARM property */ | |
/* Protected memory property */ | |
/* Android hardware buffer type value for CL_IMPORT_TYPE_ARM property */ | |
/* Data consistency with host property */ | |
/* Import memory size value to indicate a size for the whole buffer */ | |
/* This extension adds a new function that allows for direct memory import into | |
* OpenCL via the clImportMemoryARM function. | |
* | |
* Memory imported through this interface will be mapped into the device's page | |
* tables directly, providing zero copy access. It will never fall back to copy | |
* operations and aliased buffers. | |
* | |
* Types of memory supported for import are specified as additional extension | |
* strings. | |
* | |
* This extension produces cl_mem allocations which are compatible with all other | |
* users of cl_mem in the standard API. | |
* | |
* This extension maps pages with the same properties as the normal buffer creation | |
* function clCreateBuffer. | |
*/ | |
extern CL_API_ENTRY cl_mem CL_API_CALL | |
clImportMemoryARM( cl_context context, | |
cl_mem_flags flags, | |
const cl_import_properties_arm *properties, | |
void *memory, | |
size_t size, | |
cl_int *errcode_ret) CL_EXT_SUFFIX__VERSION_1_0; | |
/****************************************** | |
* cl_arm_shared_virtual_memory extension * | |
******************************************/ | |
/* Used by clGetDeviceInfo */ | |
/* Used by clGetMemObjectInfo */ | |
/* Used by clSetKernelExecInfoARM: */ | |
/* To be used by clGetEventInfo: */ | |
/* Flag values returned by clGetDeviceInfo with CL_DEVICE_SVM_CAPABILITIES_ARM as the param_name. */ | |
/* Flag values used by clSVMAllocARM: */ | |
typedef cl_bitfield cl_svm_mem_flags_arm; | |
typedef cl_uint cl_kernel_exec_info_arm; | |
typedef cl_bitfield cl_device_svm_capabilities_arm; | |
extern CL_API_ENTRY void * CL_API_CALL | |
clSVMAllocARM(cl_context context, | |
cl_svm_mem_flags_arm flags, | |
size_t size, | |
cl_uint alignment) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY void CL_API_CALL | |
clSVMFreeARM(cl_context context, | |
void * svm_pointer) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueSVMFreeARM(cl_command_queue command_queue, | |
cl_uint num_svm_pointers, | |
void * svm_pointers[], | |
void (CL_CALLBACK * pfn_free_func)(cl_command_queue queue, | |
cl_uint num_svm_pointers, | |
void * svm_pointers[], | |
void * user_data), | |
void * user_data, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueSVMMemcpyARM(cl_command_queue command_queue, | |
cl_bool blocking_copy, | |
void * dst_ptr, | |
const void * src_ptr, | |
size_t size, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueSVMMemFillARM(cl_command_queue command_queue, | |
void * svm_ptr, | |
const void * pattern, | |
size_t pattern_size, | |
size_t size, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueSVMMapARM(cl_command_queue command_queue, | |
cl_bool blocking_map, | |
cl_map_flags flags, | |
void * svm_ptr, | |
size_t size, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clEnqueueSVMUnmapARM(cl_command_queue command_queue, | |
void * svm_ptr, | |
cl_uint num_events_in_wait_list, | |
const cl_event * event_wait_list, | |
cl_event * event) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clSetKernelArgSVMPointerARM(cl_kernel kernel, | |
cl_uint arg_index, | |
const void * arg_value) CL_EXT_SUFFIX__VERSION_1_2; | |
extern CL_API_ENTRY cl_int CL_API_CALL | |
clSetKernelExecInfoARM(cl_kernel kernel, | |
cl_kernel_exec_info_arm param_name, | |
size_t param_value_size, | |
const void * param_value) CL_EXT_SUFFIX__VERSION_1_2; | |
/******************************** | |
* cl_arm_get_core_id extension * | |
********************************/ | |
/* Device info property for bitfield of cores present */ | |
/********************************* | |
* cl_arm_job_slot_selection | |
*********************************/ | |
/* cl_device_info */ | |
/* cl_command_queue_properties */ | |
/********************************* | |
* cl_arm_scheduling_controls | |
*********************************/ | |
/* cl_device_info */ | |
/* cl_kernel_info */ | |
/* cl_queue_properties */ | |
} | |