Driver types

Driver types#

enum hipChannelFormatKind#

HIP channel format kinds

Values:

enumerator hipChannelFormatKindSigned#: Signed channel format.

enumerator hipChannelFormatKindUnsigned#: Unsigned channel format.

enumerator hipChannelFormatKindFloat#: Float channel format.

enumerator hipChannelFormatKindNone#: No channel format.

enum hipArray_Format#

HIP array format

Values:

enumerator HIP_AD_FORMAT_UNSIGNED_INT8#: Unsigned 8-bit array format.

enumerator HIP_AD_FORMAT_UNSIGNED_INT16#: Unsigned 16-bit array format.

enumerator HIP_AD_FORMAT_UNSIGNED_INT32#: Unsigned 32-bit array format.

enumerator HIP_AD_FORMAT_SIGNED_INT8#: Signed 8-bit array format.

enumerator HIP_AD_FORMAT_SIGNED_INT16#: Signed 16-bit array format.

enumerator HIP_AD_FORMAT_SIGNED_INT32#: Signed 32-bit array format.

enumerator HIP_AD_FORMAT_HALF#: Half array format.

enumerator HIP_AD_FORMAT_FLOAT#: Float array format.

enum hipResourceType#

HIP resource types

Values:

enumerator hipResourceTypeArray#: Array resource.

enumerator hipResourceTypeMipmappedArray#: Mipmapped array resource.

enumerator hipResourceTypeLinear#: Linear resource.

enumerator hipResourceTypePitch2D#: Pitch 2D resource.

enum hipResourcetype#

Values:

enumerator HIP_RESOURCE_TYPE_ARRAY#: Array resource.

enumerator HIP_RESOURCE_TYPE_MIPMAPPED_ARRAY#: Mipmapped array resource.

enumerator HIP_RESOURCE_TYPE_LINEAR#: Linear resource.

enumerator HIP_RESOURCE_TYPE_PITCH2D#: Pitch 2D resource.

enum HIPaddress_mode#

HIP texture address modes

Values:

enumerator HIP_TR_ADDRESS_MODE_WRAP#: Wrap address mode.

enumerator HIP_TR_ADDRESS_MODE_CLAMP#: Clamp address mode.

enumerator HIP_TR_ADDRESS_MODE_MIRROR#: Mirror address mode.

enumerator HIP_TR_ADDRESS_MODE_BORDER#: Border address mode.

enum HIPfilter_mode#

HIP filter modes

Values:

enumerator HIP_TR_FILTER_MODE_POINT#: Filter mode point.

enumerator HIP_TR_FILTER_MODE_LINEAR#: Filter mode linear.

enum hipResourceViewFormat#

HIP texture resource view formats

Values:

enumerator hipResViewFormatNone#: No resource view format (use underlying resource format)

enumerator hipResViewFormatUnsignedChar1#: 1 channel, unsigned 8-bit integers

enumerator hipResViewFormatUnsignedChar2#: 2 channels, unsigned 8-bit integers

enumerator hipResViewFormatUnsignedChar4#: 4 channels, unsigned 8-bit integers

enumerator hipResViewFormatSignedChar1#: 1 channel, signed 8-bit integers

enumerator hipResViewFormatSignedChar2#: 2 channels, signed 8-bit integers

enumerator hipResViewFormatSignedChar4#: 4 channels, signed 8-bit integers

enumerator hipResViewFormatUnsignedShort1#: 1 channel, unsigned 16-bit integers

enumerator hipResViewFormatUnsignedShort2#: 2 channels, unsigned 16-bit integers

enumerator hipResViewFormatUnsignedShort4#: 4 channels, unsigned 16-bit integers

enumerator hipResViewFormatSignedShort1#: 1 channel, signed 16-bit integers

enumerator hipResViewFormatSignedShort2#: 2 channels, signed 16-bit integers

enumerator hipResViewFormatSignedShort4#: 4 channels, signed 16-bit integers

enumerator hipResViewFormatUnsignedInt1#: 1 channel, unsigned 32-bit integers

enumerator hipResViewFormatUnsignedInt2#: 2 channels, unsigned 32-bit integers

enumerator hipResViewFormatUnsignedInt4#: 4 channels, unsigned 32-bit integers

enumerator hipResViewFormatSignedInt1#: 1 channel, signed 32-bit integers

enumerator hipResViewFormatSignedInt2#: 2 channels, signed 32-bit integers

enumerator hipResViewFormatSignedInt4#: 4 channels, signed 32-bit integers

enumerator hipResViewFormatHalf1#: 1 channel, 16-bit floating point

enumerator hipResViewFormatHalf2#: 2 channels, 16-bit floating point

enumerator hipResViewFormatHalf4#: 4 channels, 16-bit floating point

enumerator hipResViewFormatFloat1#: 1 channel, 32-bit floating point

enumerator hipResViewFormatFloat2#: 2 channels, 32-bit floating point

enumerator hipResViewFormatFloat4#: 4 channels, 32-bit floating point

enumerator hipResViewFormatUnsignedBlockCompressed1#: Block-compressed 1.

enumerator hipResViewFormatUnsignedBlockCompressed2#: Block-compressed 2.

enumerator hipResViewFormatUnsignedBlockCompressed3#: Block-compressed 3.

enumerator hipResViewFormatUnsignedBlockCompressed4#: Block-compressed 4 unsigned.

enumerator hipResViewFormatSignedBlockCompressed4#: Block-compressed 4 signed.

enumerator hipResViewFormatUnsignedBlockCompressed5#: Block-compressed 5 unsigned.

enumerator hipResViewFormatSignedBlockCompressed5#: Block-compressed 5 signed.

enumerator hipResViewFormatUnsignedBlockCompressed6H#: Block-compressed 6 unsigned half-float.

enumerator hipResViewFormatSignedBlockCompressed6H#: Block-compressed 6 signed half-float.

enumerator hipResViewFormatUnsignedBlockCompressed7#: Block-compressed 7.

enum HIPresourceViewFormat#

HIP texture resource view formats

Values:

enumerator HIP_RES_VIEW_FORMAT_NONE#: No resource view format (use underlying resource format)

enumerator HIP_RES_VIEW_FORMAT_UINT_1X8#: 1 channel, unsigned 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_2X8#: 2 channels, unsigned 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_4X8#: 4 channels, unsigned 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_1X8#: 1 channel, signed 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_2X8#: 2 channels, signed 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_4X8#: 4 channels, signed 8-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_1X16#: 1 channel, unsigned 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_2X16#: 2 channels, unsigned 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_4X16#: 4 channels, unsigned 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_1X16#: 1 channel, signed 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_2X16#: 2 channels, signed 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_4X16#: 4 channels, signed 16-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_1X32#: 1 channel, unsigned 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_2X32#: 2 channels, unsigned 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_UINT_4X32#: 4 channels, unsigned 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_1X32#: 1 channel, signed 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_2X32#: 2 channels, signed 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_SINT_4X32#: 4 channels, signed 32-bit integers

enumerator HIP_RES_VIEW_FORMAT_FLOAT_1X16#: 1 channel, 16-bit floating point

enumerator HIP_RES_VIEW_FORMAT_FLOAT_2X16#: 2 channels, 16-bit floating point

enumerator HIP_RES_VIEW_FORMAT_FLOAT_4X16#: 4 channels, 16-bit floating point

enumerator HIP_RES_VIEW_FORMAT_FLOAT_1X32#: 1 channel, 32-bit floating point

enumerator HIP_RES_VIEW_FORMAT_FLOAT_2X32#: 2 channels, 32-bit floating point

enumerator HIP_RES_VIEW_FORMAT_FLOAT_4X32#: 4 channels, 32-bit floating point

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC1#: Block-compressed 1.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC2#: Block-compressed 2.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC3#: Block-compressed 3.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC4#: Block-compressed 4 unsigned.

enumerator HIP_RES_VIEW_FORMAT_SIGNED_BC4#: Block-compressed 4 signed.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC5#: Block-compressed 5 unsigned.

enumerator HIP_RES_VIEW_FORMAT_SIGNED_BC5#: Block-compressed 5 signed.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC6H#: Block-compressed 6 unsigned half-float.

enumerator HIP_RES_VIEW_FORMAT_SIGNED_BC6H#: Block-compressed 6 signed half-float.

enumerator HIP_RES_VIEW_FORMAT_UNSIGNED_BC7#: Block-compressed 7.

enum hipMemcpyKind#

Memory copy types

Values:

enumerator hipMemcpyHostToHost#: Host-to-Host Copy.

enumerator hipMemcpyHostToDevice#: Host-to-Device Copy.

enumerator hipMemcpyDeviceToHost#: Device-to-Host Copy.

enumerator hipMemcpyDeviceToDevice#: Device-to-Device Copy.

enumerator hipMemcpyDefault#: Runtime will automatically determine copy-kind based on virtual addresses.

enumerator hipMemcpyDeviceToDeviceNoCU#: Device-to-Device Copy without using compute units.

enum hipMemLocationType#

Specifies the type of location

Values:

enumerator hipMemLocationTypeInvalid#

enumerator hipMemLocationTypeNone#

enumerator hipMemLocationTypeDevice#: Device location, thus it’s HIP device ID.

enumerator hipMemLocationTypeHost#: Host location, id is ignored.

enumerator hipMemLocationTypeHostNuma#: Host NUMA node location, id is host NUMA node id.

enumerator hipMemLocationTypeHostNumaCurrent#: Host NUMA node closest to current thread’s CPU, id is ignored.

enum hipMemcpyFlags#

Flags to specify for copies within a batch. Used with hipMemcpyBatchAsync

Values:

enumerator hipMemcpyFlagDefault#: Default flag.

enumerator hipMemcpyFlagPreferOverlapWithCompute#: Tries to overlap copy with compute work.

enum hipMemcpySrcAccessOrder#

Flags to specify order in which source pointer is accessed by Batch memcpy

Values:

enumerator hipMemcpySrcAccessOrderInvalid#: Default Invalid.

enumerator hipMemcpySrcAccessOrderStream#: Access to source pointer must be in stream order.

enumerator hipMemcpySrcAccessOrderDuringApiCall#: Access to source pointer can be out of stream order and all accesses must be complete before API call returns.

enumerator hipMemcpySrcAccessOrderAny#: Access to the source pointer can be out of stream order and the accesses can happen even after the API call return.

enumerator hipMemcpySrcAccessOrderMax#

enum hipMemcpy3DOperandType#

Operand types for individual copies within a batch

Values:

enumerator hipMemcpyOperandTypePointer#: Mempcy operand is a valid pointer.

enumerator hipMemcpyOperandTypeArray#: Memcpy operand is a valid hipArray.

enumerator hipMemcpyOperandTypeMax#

enum hipFunction_attribute#

Values:

enumerator HIP_FUNC_ATTRIBUTE_MAX_THREADS_PER_BLOCK#: The maximum number of threads per block. Depends on function and device.

enumerator HIP_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES#: The statically allocated shared memory size in bytes per block required by the function.

enumerator HIP_FUNC_ATTRIBUTE_CONST_SIZE_BYTES#: The user-allocated constant memory by the function in bytes.

enumerator HIP_FUNC_ATTRIBUTE_LOCAL_SIZE_BYTES#: The local memory usage of each thread by this function in bytes.

enumerator HIP_FUNC_ATTRIBUTE_NUM_REGS#: The number of registers used by each thread of this function.

enumerator HIP_FUNC_ATTRIBUTE_PTX_VERSION#: PTX version.

enumerator HIP_FUNC_ATTRIBUTE_BINARY_VERSION#: Binary version.

enumerator HIP_FUNC_ATTRIBUTE_CACHE_MODE_CA#: Cache mode.

enumerator HIP_FUNC_ATTRIBUTE_MAX_DYNAMIC_SHARED_SIZE_BYTES#: The maximum dynamic shared memory per block for this function in bytes.

enumerator HIP_FUNC_ATTRIBUTE_PREFERRED_SHARED_MEMORY_CARVEOUT#: The shared memory carveout preference in percent of the maximum shared memory.

enumerator HIP_FUNC_ATTRIBUTE_MAX#

enum hipPointer_attribute#

Values:

enumerator HIP_POINTER_ATTRIBUTE_CONTEXT#: The context on which a pointer was allocated

Warning

This attribute is not supported in HIP

enumerator HIP_POINTER_ATTRIBUTE_MEMORY_TYPE#: memory type describing the location of a pointer

enumerator HIP_POINTER_ATTRIBUTE_DEVICE_POINTER#: address at which the pointer is allocated on the device

enumerator HIP_POINTER_ATTRIBUTE_HOST_POINTER#: address at which the pointer is allocated on the host

enumerator HIP_POINTER_ATTRIBUTE_P2P_TOKENS#: A pair of tokens for use with Linux kernel interface

Warning

This attribute is not supported in HIP

enumerator HIP_POINTER_ATTRIBUTE_SYNC_MEMOPS#: Synchronize every synchronous memory operation initiated on this region

enumerator HIP_POINTER_ATTRIBUTE_BUFFER_ID#: Unique ID for an allocated memory region.

enumerator HIP_POINTER_ATTRIBUTE_IS_MANAGED#: Indicates if the pointer points to managed memory.

enumerator HIP_POINTER_ATTRIBUTE_DEVICE_ORDINAL#: device ordinal of a device on which a pointer was allocated or registered

enumerator HIP_POINTER_ATTRIBUTE_IS_LEGACY_HIP_IPC_CAPABLE#: if this pointer maps to an allocation that is suitable for hipIpcGetMemHandle

Warning

This attribute is not supported in HIP

enumerator HIP_POINTER_ATTRIBUTE_RANGE_START_ADDR#: Starting address for this requested pointer.

enumerator HIP_POINTER_ATTRIBUTE_RANGE_SIZE#: Size of the address range for this requested pointer.

enumerator HIP_POINTER_ATTRIBUTE_MAPPED#: tells if this pointer is in a valid address range that is mapped to a backing allocation

enumerator HIP_POINTER_ATTRIBUTE_ALLOWED_HANDLE_TYPES#: Bitmask of allowed hipmemAllocationHandleType for this allocation

Warning

This attribute is not supported in HIP

enumerator HIP_POINTER_ATTRIBUTE_IS_GPU_DIRECT_RDMA_CAPABLE#: returns if the memory referenced by this pointer can be used with the GPUDirect RDMA API

Warning

This attribute is not supported in HIP

enumerator HIP_POINTER_ATTRIBUTE_ACCESS_FLAGS#: Returns the access flags the device associated with for the corresponding memory referenced by the ptr

enumerator HIP_POINTER_ATTRIBUTE_MEMPOOL_HANDLE#: Returns the mempool handle for the allocation if it was allocated from a mempool

Warning

This attribute is not supported in HIP

typedef void *hipDeviceptr_t#

typedef struct hipArray *hipArray_t#

typedef const struct hipArray *hipArray_const_t#

typedef hipMipmappedArray_t hipmipmappedArray#

typedef const struct hipMipmappedArray *hipMipmappedArray_const_t#

static inline struct hipPitchedPtr make_hipPitchedPtr(void *d, size_t p, size_t xsz, size_t ysz)#

Make hipPitchedPtr.

Parameters:

d – [in] Pointer to the allocated memory
p – [in] Pitch in bytes
xsz – [in] Logical size of the first dimension of allocation in elements
ysz – [in] Logical size of the second dimension of allocation in elements

Returns:

The created hipPitchedPtr

static inline struct hipPos make_hipPos(size_t x, size_t y, size_t z)#

Make hipPos struct.

Parameters:

x – [in] X coordinate of the new hipPos
y – [in] Y coordinate of the new hipPos
z – [in] Z coordinate of the new hipPos

Returns:

The created hipPos struct

static inline struct hipExtent make_hipExtent(size_t w, size_t h, size_t d)#

Make hipExtent struct.

Parameters:

w – [in] Width of the new hipExtent
h – [in] Height of the new hipExtent
d – [in] Depth of the new hipExtent

Returns:

The created hipExtent struct

HIP_TRSA_OVERRIDE_FORMAT#: The hipTexRefSetArray function flags parameter override format value.

HIP_TRSF_READ_AS_INTEGER#: The hipTexRefSetFlags function flags parameter read as integer value.

HIP_TRSF_NORMALIZED_COORDINATES#: The hipTexRefSetFlags function flags parameter normalized coordinate value.

HIP_TRSF_SRGB#: The hipTexRefSetFlags function flags parameter srgb value.

struct hipChannelFormatDesc#: #include <driver_types.h>

HIP channel format descriptor

struct HIP_ARRAY_DESCRIPTOR#: #include <driver_types.h>

HIP array descriptor

struct HIP_ARRAY3D_DESCRIPTOR#: #include <driver_types.h>

HIP 3D array descriptor

struct hip_Memcpy2D#: #include <driver_types.h>

HIP 2D memory copy parameters

struct hipMipmappedArray#

#include <driver_types.h>

HIP mipmapped array

HIP mipmapped array pointer

struct HIP_TEXTURE_DESC#: #include <driver_types.h>

HIP texture descriptor

struct hipResourceDesc#: #include <driver_types.h>

HIP resource descriptor

struct HIP_RESOURCE_DESC#: #include <driver_types.h>

HIP resource view descriptor struct

struct hipResourceViewDesc#: #include <driver_types.h>

HIP resource view descriptor

struct HIP_RESOURCE_VIEW_DESC#: #include <driver_types.h>

Resource view descriptor

struct hipPitchedPtr#: #include <driver_types.h>

HIP pithed pointer

struct hipExtent#: #include <driver_types.h>

HIP extent

struct hipPos#: #include <driver_types.h>

HIP position

struct hipMemcpy3DParms#: #include <driver_types.h>

HIP 3D memory copy parameters

struct HIP_MEMCPY3D#: #include <driver_types.h>

HIP 3D memory copy

struct hipMemLocation#

#include <driver_types.h>

Specifies a memory location.

To specify a gpu, set type = hipMemLocationTypeDevice and set id = the gpu’s device ID

struct hipMemcpyAttributes#: #include <driver_types.h>

Attributes for copies within a batch.

struct hipOffset3D#: #include <driver_types.h>

Struct representing offset into a hipArray_t in elements.

struct hipMemcpy3DOperand#: #include <driver_types.h>

Struct representing an operand for copy with hipMemcpy3DBatchAsync.

struct hipMemcpy3DBatchOp#: #include <driver_types.h>

HIP 3D Batch Op

struct hipMemcpy3DPeerParms#: #include <driver_types.h>

Driver types

Contents

Driver types#