Browse Source

fix function prototype

Nathalie Furmento 13 years ago
parent
commit
e4b9b74e75
2 changed files with 15 additions and 22 deletions
  1. 10 10
      doc/chapters/basic-api.texi
  2. 5 12
      include/starpu_opencl.h

+ 10 - 10
doc/chapters/basic-api.texi

@@ -1984,13 +1984,13 @@ message and the given error @var{status}, with the current function
 name, current file and line number.
 @end defmac
 
-@deftypefun cl_int starpu_opencl_allocate_memory (cl_mem *mem, size_t size, cl_mem_flags flags)
-Allocate @var{size} bytes of memory, stored in @var{mem}. @var{flags} must be a
+@deftypefun cl_int starpu_opencl_allocate_memory ({cl_mem *}@var{addr}, size_t @var{size}, cl_mem_flags @var{flags})
+Allocate @var{size} bytes of memory, stored in @var{addr}. @var{flags} must be a
 valid combination of cl_mem_flags values.
 @end deftypefun
 
-@deftypefun cl_int starpu_opencl_copy_ram_to_opencl_async_sync (void *pointer, unsigned src_node, cl_mem buffer, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret)
-Copy @var{size} bytes asynchronously from the given @var{pointer} on
+@deftypefun cl_int starpu_opencl_copy_ram_to_opencl_async_sync ({void *}@var{ptr}, unsigned @var{src_node}, cl_mem @var{buffer}, unsigned @var{dst_node}, size_t @var{size}, size_t @var{offset}, {cl_event *}@var{event}, {int *}@var{ret})
+Copy @var{size} bytes asynchronously from the given @var{ptr} on
 @var{src_node} to the given @var{buffer} on @var{dst_node}.
 @var{offset} is the offset, in bytes, in @var{buffer}.
 @var{event} can be used to wait for this particular copy to complete. It can be
@@ -2000,8 +2000,8 @@ otherwise. The integer pointed to by @var{ret} is set to -EAGAIN if the asynchro
 was successful, or to 0 if event was NULL.
 @end deftypefun
 
-@deftypefun cl_int starpu_opencl_copy_ram_to_opencl (void *pointer, unsigned src_node STARPU_ATTRIBUTE_UNUSED, cl_mem buffer, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t size, size_t offset, cl_event *event)
-Copy @var{size} bytes from the given @var{pointer} on @var{src_node} to the
+@deftypefun cl_int starpu_opencl_copy_ram_to_opencl ({void *}@var{ptr}, unsigned @var{src_node}, cl_mem @var{buffer}, unsigned @var{dst_node}, size_t @var{size}, size_t @var{offset}, {cl_event *}@var{event})
+Copy @var{size} bytes from the given @var{ptr} on @var{src_node} to the
 given @var{buffer} on @var{dst_node}. @var{offset} is the offset, in bytes,
 in @var{buffer}. @var{event} can be used to wait for this particular copy to
 complete. It can be NULL.
@@ -2009,9 +2009,9 @@ This function returns CL_SUCCESS if the copy was successful, or a valid OpenCL e
 otherwise.
 @end deftypefun
 
-@deftypefun cl_int starpu_opencl_copy_opencl_to_ram_async_sync (cl_mem buffer, unsigned src_node STARPU_ATTRIBUTE_UNUSED, void *pointer, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t size, size_t offset, cl_event *event, int *ret)
+@deftypefun cl_int starpu_opencl_copy_opencl_to_ram_async_sync (cl_mem @var{buffer}, unsigned @var{src_node}, void *@var{ptr}, unsigned @var{dst_node}, size_t @var{size}, size_t @var{offset}, {cl_event *}@var{event}, {int *}@var{ret})
 Copy @var{size} bytes asynchronously from the given @var{buffer} on
-@var{src_node} to the given @var{pointer} on @var{dst_node}.
+@var{src_node} to the given @var{ptr} on @var{dst_node}.
 @var{offset} is the offset, in bytes, in @var{buffer}.
 @var{event} can be used to wait for this particular copy to complete. It can be
 NULL.
@@ -2020,9 +2020,9 @@ otherwise. The integer pointed to by @var{ret} is set to -EAGAIN if the asynchro
 was successful, or to 0 if event was NULL.
 @end deftypefun
 
-@deftypefun cl_int starpu_opencl_copy_opencl_to_ram (cl_mem buffer, unsigned src_node STARPU_ATTRIBUTE_UNUSED, void *pointerr, unsigned dst_node STARPU_ATTRIBUTE_UNUSED, size_t size, size_t offset, cl_event *event)
+@deftypefun cl_int starpu_opencl_copy_opencl_to_ram (cl_mem @var{buffer}, unsigned @var{src_node}, void *@var{ptr}, unsigned @var{dst_node}, size_t @var{size}, size_t @var{offset}, {cl_event *}@var{event})
 Copy @var{size} bytes from the given @var{buffer} on @var{src_node} to the
-given @var{pointer} on @var{dst_node}. @var{offset} is the offset, in bytes,
+given @var{ptr} on @var{dst_node}. @var{offset} is the offset, in bytes,
 in @var{buffer}. @var{event} can be used to wait for this particular copy to
 complete. It can be NULL.
 This function returns CL_SUCCESS if the copy was successful, or a valid OpenCL error code

+ 5 - 12
include/starpu_opencl.h

@@ -94,21 +94,14 @@ int starpu_opencl_set_kernel_args(cl_int *err, cl_kernel *kernel, ...);
 
 cl_int starpu_opencl_allocate_memory(cl_mem *addr, size_t size, cl_mem_flags flags);
 
-cl_int starpu_opencl_copy_ram_to_opencl(void *ptr, unsigned src_node,
-	cl_mem buffer, unsigned dst_node, size_t size, size_t offset,
-	cl_event *event);
+cl_int starpu_opencl_copy_ram_to_opencl(void *ptr, unsigned src_node, cl_mem buffer, unsigned dst_node, size_t size, size_t offset, cl_event *event);
 
-cl_int starpu_opencl_copy_opencl_to_ram(cl_mem buffer, unsigned src_node,
-	void *ptr, unsigned dst_node, size_t size, size_t offset,
-	cl_event *event);
+cl_int starpu_opencl_copy_opencl_to_ram(cl_mem buffer, unsigned src_node, void *ptr, unsigned dst_node, size_t size, size_t offset, cl_event *event);
 
-cl_int starpu_opencl_copy_ram_to_opencl_async_sync(void *ptr, unsigned src_node,
-	cl_mem buffer, unsigned dst_node, size_t size, size_t offset,
-	cl_event *event, int *ret);
+cl_int starpu_opencl_copy_ram_to_opencl_async_sync(void *ptr, unsigned src_node, cl_mem buffer, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret);
+
+cl_int starpu_opencl_copy_opencl_to_ram_async_sync(cl_mem buffer, unsigned src_node, void *ptr, unsigned dst_node, size_t size, size_t offset, cl_event *event, int *ret);
 
-cl_int starpu_opencl_copy_opencl_to_ram_async_sync(cl_mem buffer,
-	unsigned src_node, void *ptr, unsigned dst_node, size_t size,
-	size_t offset, cl_event *event, int *ret);
 #ifdef __cplusplus
 }
 #endif