Browse Source

doc: update OpenCL section

Nathalie Furmento 13 years ago
parent
commit
60644856a4
1 changed files with 42 additions and 17 deletions
  1. 42 17
      doc/starpu.texi

+ 42 - 17
doc/starpu.texi

@@ -4764,11 +4764,43 @@ This function synchronously deinitializes the CUBLAS library on every CUDA devic
 @section OpenCL extensions
 
 @menu
-* Compiling OpenCL kernels::   Compiling OpenCL kernels
-* Loading OpenCL kernels::     Loading OpenCL kernels
-* OpenCL statistics::          Collecting statistics from OpenCL
+* Writing OpenCL kernels::      Writing OpenCL kernels
+* Compiling OpenCL kernels::    Compiling OpenCL kernels
+* Loading OpenCL kernels::      Loading OpenCL kernels
+* OpenCL statistics::           Collecting statistics from OpenCL
 @end menu
 
+@node Writing OpenCL kernels
+@subsection Writing OpenCL kernels
+
+@deftypefun void starpu_opencl_display_error ({const char *}@var{func}, {const char *}@var{file}, int @var{line}, {const char *}@var{msg}, cl_int @var{status})
+todo
+@end deftypefun
+
+@deftypefun size_t starpu_opencl_get_global_mem_size (int @var{devid})
+todo
+@end deftypefun
+
+@deftypefun void starpu_opencl_get_context (int @var{devid}, {cl_context *}@var{context})
+todo
+@end deftypefun
+
+@deftypefun void starpu_opencl_get_device (int @var{devid}, {cl_device_id *}@var{device})
+todo
+@end deftypefun
+
+@deftypefun void starpu_opencl_get_queue (int @var{devid}, {cl_command_queue *}@var{queue});
+todo
+@end deftypefun
+
+@deftypefun void starpu_opencl_get_current_context ({cl_context *}@var{context})
+todo
+@end deftypefun
+
+@deftypefun void starpu_opencl_get_current_queue ({cl_command_queue *}@var{queue})
+todo
+@end deftypefun
+
 @node Compiling OpenCL kernels
 @subsection Compiling OpenCL kernels
 
@@ -4781,28 +4813,21 @@ can also fill a @code{starpu_opencl_program} array by hand for more advanced
 use (e.g. different programs on the different OpenCL devices, for
 relocation purpose for instance).
 
-@menu
-* starpu_opencl_load_opencl_from_file::  Compiling OpenCL source code
-* starpu_opencl_load_opencl_from_string::  Compiling OpenCL source code
-* starpu_opencl_unload_opencl::  Releasing OpenCL code
-@end menu
+@deftp {Data Type} {struct starpu_opencl_program}
+todo
+@end deftp
 
-@node starpu_opencl_load_opencl_from_file
-@subsubsection @code{starpu_opencl_load_opencl_from_file} -- Compiling OpenCL source code
 @deftypefun int starpu_opencl_load_opencl_from_file (char *@var{source_file_name}, {struct starpu_opencl_program} *@var{opencl_programs}, {const char}* @var{build_options})
-TODO
+@anchor{starpu_opencl_load_opencl_from_file}
+This function compiles an OpenCL source code stored in a file.
 @end deftypefun
 
-@node starpu_opencl_load_opencl_from_string
-@subsubsection @code{starpu_opencl_load_opencl_from_string} -- Compiling OpenCL source code
 @deftypefun int starpu_opencl_load_opencl_from_string (char *@var{opencl_program_source}, {struct starpu_opencl_program} *@var{opencl_programs}, {const char}* @var{build_options})
-TODO
+This function compiles an OpenCL source code stored in a string.
 @end deftypefun
 
-@node starpu_opencl_unload_opencl
-@subsubsection @code{starpu_opencl_unload_opencl} -- Releasing OpenCL code
 @deftypefun int starpu_opencl_unload_opencl ({struct starpu_opencl_program} *@var{opencl_programs})
-TODO
+This function releases an OpenCL compiled code.
 @end deftypefun
 
 @node Loading OpenCL kernels