odla_memory.h File Reference

Go to the source code of this file.

Enumerations
enum	odla_memcpy_type { ODLA_MEMCPY_H2H , ODLA_MEMCPY_H2D , ODLA_MEMCPY_D2H , ODLA_MEMCPY_D2D }
	memory copy types More...

Functions
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_AllocateDeviceMemory (odla_void **dev_ptr, odla_size_t size)
	Allocate device memory. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_FreeDeviceMemory (odla_void *ptr)
	Free device memory. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_AllocateHostMemory (odla_void **host_ptr, odla_size_t size)
	Allocate host memory. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_FreeHostMemory (odla_void *ptr)
	Free host memory. More...
ODLA_API_EXPORT odla_status ODLA_API_CALL	odla_CopyMemory (odla_void *dst, odla_void *src, odla_size_t size, odla_memcpy_type type)
	Copy data between host and device. More...

Detailed Description

This file defines the ODLA memory related APIs.

Definition in file odla_memory.h.

Enumeration Type Documentation

odla_memcpy_type

enum odla_memcpy_type

memory copy types

Definition at line 32 of file odla_memory.h.

             {
  ODLA_MEMCPY_H2H,
  ODLA_MEMCPY_H2D,
  ODLA_MEMCPY_D2H,
  ODLA_MEMCPY_D2D,
} odla_memcpy_type;

Function Documentation

odla_AllocateDeviceMemory()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_AllocateDeviceMemory	(	odla_void **	dev_ptr,
		odla_size_t	size
	)

Allocate device memory.

Parameters

devPtr	the pointer to allocated device memory
size	the requested allocation size in bytes

Returns

odla_status

odla_AllocateHostMemory()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_AllocateHostMemory	(	odla_void **	host_ptr,
		odla_size_t	size
	)

Allocate host memory.

Parameters

ptr	the pointer to allocated host memory
size	the requested allocation size in bytes

Returns

odla_status

odla_CopyMemory()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_CopyMemory	(	odla_void *	dst,
		odla_void *	src,
		odla_size_t	size,
		odla_memcpy_type	type
	)

Copy data between host and device.

Parameters

dst	the destination memory address
src	the source memory address
size	the size in bytes to copy
type	the memory copy type

Returns

odla_status

odla_FreeDeviceMemory()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_FreeDeviceMemory

(

odla_void *

ptr

)

Free device memory.

Parameters

devPtr

the device pointer to memory to free

Returns

odla_status

odla_FreeHostMemory()

ODLA_API_EXPORT odla_status ODLA_API_CALL odla_FreeHostMemory

(

odla_void *

ptr

)

Free host memory.

Parameters

ptr	the host pointer to memory to free

Returns

odla_status