amdgpu.h revision 00a23bda
13f012e29Smrg/*
23f012e29Smrg * Copyright 2014 Advanced Micro Devices, Inc.
33f012e29Smrg *
43f012e29Smrg * Permission is hereby granted, free of charge, to any person obtaining a
53f012e29Smrg * copy of this software and associated documentation files (the "Software"),
63f012e29Smrg * to deal in the Software without restriction, including without limitation
73f012e29Smrg * the rights to use, copy, modify, merge, publish, distribute, sublicense,
83f012e29Smrg * and/or sell copies of the Software, and to permit persons to whom the
93f012e29Smrg * Software is furnished to do so, subject to the following conditions:
103f012e29Smrg *
113f012e29Smrg * The above copyright notice and this permission notice shall be included in
123f012e29Smrg * all copies or substantial portions of the Software.
133f012e29Smrg *
143f012e29Smrg * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
153f012e29Smrg * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
163f012e29Smrg * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
173f012e29Smrg * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
183f012e29Smrg * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
193f012e29Smrg * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
203f012e29Smrg * OTHER DEALINGS IN THE SOFTWARE.
213f012e29Smrg *
223f012e29Smrg */
233f012e29Smrg
243f012e29Smrg/**
253f012e29Smrg * \file amdgpu.h
263f012e29Smrg *
273f012e29Smrg * Declare public libdrm_amdgpu API
283f012e29Smrg *
293f012e29Smrg * This file define API exposed by libdrm_amdgpu library.
303f012e29Smrg * User wanted to use libdrm_amdgpu functionality must include
313f012e29Smrg * this file.
323f012e29Smrg *
333f012e29Smrg */
343f012e29Smrg#ifndef _AMDGPU_H_
353f012e29Smrg#define _AMDGPU_H_
363f012e29Smrg
373f012e29Smrg#include <stdint.h>
383f012e29Smrg#include <stdbool.h>
393f012e29Smrg
40d8807b2fSmrg#ifdef __cplusplus
41d8807b2fSmrgextern "C" {
42d8807b2fSmrg#endif
43d8807b2fSmrg
443f012e29Smrgstruct drm_amdgpu_info_hw_ip;
453f012e29Smrg
463f012e29Smrg/*--------------------------------------------------------------------------*/
473f012e29Smrg/* --------------------------- Defines ------------------------------------ */
483f012e29Smrg/*--------------------------------------------------------------------------*/
493f012e29Smrg
503f012e29Smrg/**
513f012e29Smrg * Define max. number of Command Buffers (IB) which could be sent to the single
523f012e29Smrg * hardware IP to accommodate CE/DE requirements
533f012e29Smrg *
543f012e29Smrg * \sa amdgpu_cs_ib_info
553f012e29Smrg*/
563f012e29Smrg#define AMDGPU_CS_MAX_IBS_PER_SUBMIT		4
573f012e29Smrg
583f012e29Smrg/**
593f012e29Smrg * Special timeout value meaning that the timeout is infinite.
603f012e29Smrg */
613f012e29Smrg#define AMDGPU_TIMEOUT_INFINITE			0xffffffffffffffffull
623f012e29Smrg
633f012e29Smrg/**
643f012e29Smrg * Used in amdgpu_cs_query_fence_status(), meaning that the given timeout
653f012e29Smrg * is absolute.
663f012e29Smrg */
673f012e29Smrg#define AMDGPU_QUERY_FENCE_TIMEOUT_IS_ABSOLUTE     (1 << 0)
683f012e29Smrg
693f012e29Smrg/*--------------------------------------------------------------------------*/
703f012e29Smrg/* ----------------------------- Enums ------------------------------------ */
713f012e29Smrg/*--------------------------------------------------------------------------*/
723f012e29Smrg
733f012e29Smrg/**
743f012e29Smrg * Enum describing possible handle types
753f012e29Smrg *
763f012e29Smrg * \sa amdgpu_bo_import, amdgpu_bo_export
773f012e29Smrg *
783f012e29Smrg*/
793f012e29Smrgenum amdgpu_bo_handle_type {
803f012e29Smrg	/** GEM flink name (needs DRM authentication, used by DRI2) */
813f012e29Smrg	amdgpu_bo_handle_type_gem_flink_name = 0,
823f012e29Smrg
833f012e29Smrg	/** KMS handle which is used by all driver ioctls */
843f012e29Smrg	amdgpu_bo_handle_type_kms = 1,
853f012e29Smrg
863f012e29Smrg	/** DMA-buf fd handle */
873f012e29Smrg	amdgpu_bo_handle_type_dma_buf_fd = 2
883f012e29Smrg};
893f012e29Smrg
903f012e29Smrg/** Define known types of GPU VM VA ranges */
913f012e29Smrgenum amdgpu_gpu_va_range
923f012e29Smrg{
933f012e29Smrg	/** Allocate from "normal"/general range */
943f012e29Smrg	amdgpu_gpu_va_range_general = 0
953f012e29Smrg};
963f012e29Smrg
9700a23bdaSmrgenum amdgpu_sw_info {
9800a23bdaSmrg	amdgpu_sw_info_address32_hi = 0,
9900a23bdaSmrg};
10000a23bdaSmrg
1013f012e29Smrg/*--------------------------------------------------------------------------*/
1023f012e29Smrg/* -------------------------- Datatypes ----------------------------------- */
1033f012e29Smrg/*--------------------------------------------------------------------------*/
1043f012e29Smrg
1053f012e29Smrg/**
1063f012e29Smrg * Define opaque pointer to context associated with fd.
1073f012e29Smrg * This context will be returned as the result of
1083f012e29Smrg * "initialize" function and should be pass as the first
1093f012e29Smrg * parameter to any API call
1103f012e29Smrg */
1113f012e29Smrgtypedef struct amdgpu_device *amdgpu_device_handle;
1123f012e29Smrg
1133f012e29Smrg/**
1143f012e29Smrg * Define GPU Context type as pointer to opaque structure
1153f012e29Smrg * Example of GPU Context is the "rendering" context associated
1163f012e29Smrg * with OpenGL context (glCreateContext)
1173f012e29Smrg */
1183f012e29Smrgtypedef struct amdgpu_context *amdgpu_context_handle;
1193f012e29Smrg
1203f012e29Smrg/**
1213f012e29Smrg * Define handle for amdgpu resources: buffer, GDS, etc.
1223f012e29Smrg */
1233f012e29Smrgtypedef struct amdgpu_bo *amdgpu_bo_handle;
1243f012e29Smrg
1253f012e29Smrg/**
1263f012e29Smrg * Define handle for list of BOs
1273f012e29Smrg */
1283f012e29Smrgtypedef struct amdgpu_bo_list *amdgpu_bo_list_handle;
1293f012e29Smrg
1303f012e29Smrg/**
1313f012e29Smrg * Define handle to be used to work with VA allocated ranges
1323f012e29Smrg */
1333f012e29Smrgtypedef struct amdgpu_va *amdgpu_va_handle;
1343f012e29Smrg
1353f012e29Smrg/**
1363f012e29Smrg * Define handle for semaphore
1373f012e29Smrg */
1383f012e29Smrgtypedef struct amdgpu_semaphore *amdgpu_semaphore_handle;
1393f012e29Smrg
1403f012e29Smrg/*--------------------------------------------------------------------------*/
1413f012e29Smrg/* -------------------------- Structures ---------------------------------- */
1423f012e29Smrg/*--------------------------------------------------------------------------*/
1433f012e29Smrg
1443f012e29Smrg/**
1453f012e29Smrg * Structure describing memory allocation request
1463f012e29Smrg *
1473f012e29Smrg * \sa amdgpu_bo_alloc()
1483f012e29Smrg *
1493f012e29Smrg*/
1503f012e29Smrgstruct amdgpu_bo_alloc_request {
1513f012e29Smrg	/** Allocation request. It must be aligned correctly. */
1523f012e29Smrg	uint64_t alloc_size;
1533f012e29Smrg
1543f012e29Smrg	/**
1553f012e29Smrg	 * It may be required to have some specific alignment requirements
1563f012e29Smrg	 * for physical back-up storage (e.g. for displayable surface).
1573f012e29Smrg	 * If 0 there is no special alignment requirement
1583f012e29Smrg	 */
1593f012e29Smrg	uint64_t phys_alignment;
1603f012e29Smrg
1613f012e29Smrg	/**
1623f012e29Smrg	 * UMD should specify where to allocate memory and how it
1633f012e29Smrg	 * will be accessed by the CPU.
1643f012e29Smrg	 */
1653f012e29Smrg	uint32_t preferred_heap;
1663f012e29Smrg
1673f012e29Smrg	/** Additional flags passed on allocation */
1683f012e29Smrg	uint64_t flags;
1693f012e29Smrg};
1703f012e29Smrg
1713f012e29Smrg/**
1723f012e29Smrg * Special UMD specific information associated with buffer.
1733f012e29Smrg *
1743f012e29Smrg * It may be need to pass some buffer charactersitic as part
1753f012e29Smrg * of buffer sharing. Such information are defined UMD and
1763f012e29Smrg * opaque for libdrm_amdgpu as well for kernel driver.
1773f012e29Smrg *
1783f012e29Smrg * \sa amdgpu_bo_set_metadata(), amdgpu_bo_query_info,
1793f012e29Smrg *     amdgpu_bo_import(), amdgpu_bo_export
1803f012e29Smrg *
1813f012e29Smrg*/
1823f012e29Smrgstruct amdgpu_bo_metadata {
1833f012e29Smrg	/** Special flag associated with surface */
1843f012e29Smrg	uint64_t flags;
1853f012e29Smrg
1863f012e29Smrg	/**
1873f012e29Smrg	 * ASIC-specific tiling information (also used by DCE).
1883f012e29Smrg	 * The encoding is defined by the AMDGPU_TILING_* definitions.
1893f012e29Smrg	 */
1903f012e29Smrg	uint64_t tiling_info;
1913f012e29Smrg
1923f012e29Smrg	/** Size of metadata associated with the buffer, in bytes. */
1933f012e29Smrg	uint32_t size_metadata;
1943f012e29Smrg
1953f012e29Smrg	/** UMD specific metadata. Opaque for kernel */
1963f012e29Smrg	uint32_t umd_metadata[64];
1973f012e29Smrg};
1983f012e29Smrg
1993f012e29Smrg/**
2003f012e29Smrg * Structure describing allocated buffer. Client may need
2013f012e29Smrg * to query such information as part of 'sharing' buffers mechanism
2023f012e29Smrg *
2033f012e29Smrg * \sa amdgpu_bo_set_metadata(), amdgpu_bo_query_info(),
2043f012e29Smrg *     amdgpu_bo_import(), amdgpu_bo_export()
2053f012e29Smrg*/
2063f012e29Smrgstruct amdgpu_bo_info {
2073f012e29Smrg	/** Allocated memory size */
2083f012e29Smrg	uint64_t alloc_size;
2093f012e29Smrg
2103f012e29Smrg	/**
2113f012e29Smrg	 * It may be required to have some specific alignment requirements
2123f012e29Smrg	 * for physical back-up storage.
2133f012e29Smrg	 */
2143f012e29Smrg	uint64_t phys_alignment;
2153f012e29Smrg
2163f012e29Smrg	/** Heap where to allocate memory. */
2173f012e29Smrg	uint32_t preferred_heap;
2183f012e29Smrg
2193f012e29Smrg	/** Additional allocation flags. */
2203f012e29Smrg	uint64_t alloc_flags;
2213f012e29Smrg
2223f012e29Smrg	/** Metadata associated with buffer if any. */
2233f012e29Smrg	struct amdgpu_bo_metadata metadata;
2243f012e29Smrg};
2253f012e29Smrg
2263f012e29Smrg/**
2273f012e29Smrg * Structure with information about "imported" buffer
2283f012e29Smrg *
2293f012e29Smrg * \sa amdgpu_bo_import()
2303f012e29Smrg *
2313f012e29Smrg */
2323f012e29Smrgstruct amdgpu_bo_import_result {
2333f012e29Smrg	/** Handle of memory/buffer to use */
2343f012e29Smrg	amdgpu_bo_handle buf_handle;
2353f012e29Smrg
2363f012e29Smrg	 /** Buffer size */
2373f012e29Smrg	uint64_t alloc_size;
2383f012e29Smrg};
2393f012e29Smrg
2403f012e29Smrg/**
2413f012e29Smrg *
2423f012e29Smrg * Structure to describe GDS partitioning information.
2433f012e29Smrg * \note OA and GWS resources are asscoiated with GDS partition
2443f012e29Smrg *
2453f012e29Smrg * \sa amdgpu_gpu_resource_query_gds_info
2463f012e29Smrg *
2473f012e29Smrg*/
2483f012e29Smrgstruct amdgpu_gds_resource_info {
2493f012e29Smrg	uint32_t gds_gfx_partition_size;
2503f012e29Smrg	uint32_t compute_partition_size;
2513f012e29Smrg	uint32_t gds_total_size;
2523f012e29Smrg	uint32_t gws_per_gfx_partition;
2533f012e29Smrg	uint32_t gws_per_compute_partition;
2543f012e29Smrg	uint32_t oa_per_gfx_partition;
2553f012e29Smrg	uint32_t oa_per_compute_partition;
2563f012e29Smrg};
2573f012e29Smrg
2583f012e29Smrg/**
2593f012e29Smrg * Structure describing CS fence
2603f012e29Smrg *
2613f012e29Smrg * \sa amdgpu_cs_query_fence_status(), amdgpu_cs_request, amdgpu_cs_submit()
2623f012e29Smrg *
2633f012e29Smrg*/
2643f012e29Smrgstruct amdgpu_cs_fence {
2653f012e29Smrg
2663f012e29Smrg	/** In which context IB was sent to execution */
2673f012e29Smrg	amdgpu_context_handle context;
2683f012e29Smrg
2693f012e29Smrg	/** To which HW IP type the fence belongs */
2703f012e29Smrg	uint32_t ip_type;
2713f012e29Smrg
2723f012e29Smrg	/** IP instance index if there are several IPs of the same type. */
2733f012e29Smrg	uint32_t ip_instance;
2743f012e29Smrg
2753f012e29Smrg	/** Ring index of the HW IP */
2763f012e29Smrg	uint32_t ring;
2773f012e29Smrg
2783f012e29Smrg	/** Specify fence for which we need to check submission status.*/
2793f012e29Smrg	uint64_t fence;
2803f012e29Smrg};
2813f012e29Smrg
2823f012e29Smrg/**
2833f012e29Smrg * Structure describing IB
2843f012e29Smrg *
2853f012e29Smrg * \sa amdgpu_cs_request, amdgpu_cs_submit()
2863f012e29Smrg *
2873f012e29Smrg*/
2883f012e29Smrgstruct amdgpu_cs_ib_info {
2893f012e29Smrg	/** Special flags */
2903f012e29Smrg	uint64_t flags;
2913f012e29Smrg
2923f012e29Smrg	/** Virtual MC address of the command buffer */
2933f012e29Smrg	uint64_t ib_mc_address;
2943f012e29Smrg
2953f012e29Smrg	/**
2963f012e29Smrg	 * Size of Command Buffer to be submitted.
2973f012e29Smrg	 *   - The size is in units of dwords (4 bytes).
2983f012e29Smrg	 *   - Could be 0
2993f012e29Smrg	 */
3003f012e29Smrg	uint32_t size;
3013f012e29Smrg};
3023f012e29Smrg
3033f012e29Smrg/**
3043f012e29Smrg * Structure describing fence information
3053f012e29Smrg *
3063f012e29Smrg * \sa amdgpu_cs_request, amdgpu_cs_query_fence,
3073f012e29Smrg *     amdgpu_cs_submit(), amdgpu_cs_query_fence_status()
3083f012e29Smrg*/
3093f012e29Smrgstruct amdgpu_cs_fence_info {
3103f012e29Smrg	/** buffer object for the fence */
3113f012e29Smrg	amdgpu_bo_handle handle;
3123f012e29Smrg
3133f012e29Smrg	/** fence offset in the unit of sizeof(uint64_t) */
3143f012e29Smrg	uint64_t offset;
3153f012e29Smrg};
3163f012e29Smrg
3173f012e29Smrg/**
3183f012e29Smrg * Structure describing submission request
3193f012e29Smrg *
3203f012e29Smrg * \note We could have several IBs as packet. e.g. CE, CE, DE case for gfx
3213f012e29Smrg *
3223f012e29Smrg * \sa amdgpu_cs_submit()
3233f012e29Smrg*/
3243f012e29Smrgstruct amdgpu_cs_request {
3253f012e29Smrg	/** Specify flags with additional information */
3263f012e29Smrg	uint64_t flags;
3273f012e29Smrg
3283f012e29Smrg	/** Specify HW IP block type to which to send the IB. */
3293f012e29Smrg	unsigned ip_type;
3303f012e29Smrg
3313f012e29Smrg	/** IP instance index if there are several IPs of the same type. */
3323f012e29Smrg	unsigned ip_instance;
3333f012e29Smrg
3343f012e29Smrg	/**
3353f012e29Smrg	 * Specify ring index of the IP. We could have several rings
3363f012e29Smrg	 * in the same IP. E.g. 0 for SDMA0 and 1 for SDMA1.
3373f012e29Smrg	 */
3383f012e29Smrg	uint32_t ring;
3393f012e29Smrg
3403f012e29Smrg	/**
3413f012e29Smrg	 * List handle with resources used by this request.
3423f012e29Smrg	 */
3433f012e29Smrg	amdgpu_bo_list_handle resources;
3443f012e29Smrg
3453f012e29Smrg	/**
3463f012e29Smrg	 * Number of dependencies this Command submission needs to
3473f012e29Smrg	 * wait for before starting execution.
3483f012e29Smrg	 */
3493f012e29Smrg	uint32_t number_of_dependencies;
3503f012e29Smrg
3513f012e29Smrg	/**
3523f012e29Smrg	 * Array of dependencies which need to be met before
3533f012e29Smrg	 * execution can start.
3543f012e29Smrg	 */
3553f012e29Smrg	struct amdgpu_cs_fence *dependencies;
3563f012e29Smrg
3573f012e29Smrg	/** Number of IBs to submit in the field ibs. */
3583f012e29Smrg	uint32_t number_of_ibs;
3593f012e29Smrg
3603f012e29Smrg	/**
3613f012e29Smrg	 * IBs to submit. Those IBs will be submit together as single entity
3623f012e29Smrg	 */
3633f012e29Smrg	struct amdgpu_cs_ib_info *ibs;
3643f012e29Smrg
3653f012e29Smrg	/**
3663f012e29Smrg	 * The returned sequence number for the command submission
3673f012e29Smrg	 */
3683f012e29Smrg	uint64_t seq_no;
3693f012e29Smrg
3703f012e29Smrg	/**
3713f012e29Smrg	 * The fence information
3723f012e29Smrg	 */
3733f012e29Smrg	struct amdgpu_cs_fence_info fence_info;
3743f012e29Smrg};
3753f012e29Smrg
3763f012e29Smrg/**
3773f012e29Smrg * Structure which provide information about GPU VM MC Address space
3783f012e29Smrg * alignments requirements
3793f012e29Smrg *
3803f012e29Smrg * \sa amdgpu_query_buffer_size_alignment
3813f012e29Smrg */
3823f012e29Smrgstruct amdgpu_buffer_size_alignments {
3833f012e29Smrg	/** Size alignment requirement for allocation in
3843f012e29Smrg	 * local memory */
3853f012e29Smrg	uint64_t size_local;
3863f012e29Smrg
3873f012e29Smrg	/**
3883f012e29Smrg	 * Size alignment requirement for allocation in remote memory
3893f012e29Smrg	 */
3903f012e29Smrg	uint64_t size_remote;
3913f012e29Smrg};
3923f012e29Smrg
3933f012e29Smrg/**
3943f012e29Smrg * Structure which provide information about heap
3953f012e29Smrg *
3963f012e29Smrg * \sa amdgpu_query_heap_info()
3973f012e29Smrg *
3983f012e29Smrg */
3993f012e29Smrgstruct amdgpu_heap_info {
4003f012e29Smrg	/** Theoretical max. available memory in the given heap */
4013f012e29Smrg	uint64_t heap_size;
4023f012e29Smrg
4033f012e29Smrg	/**
4043f012e29Smrg	 * Number of bytes allocated in the heap. This includes all processes
4053f012e29Smrg	 * and private allocations in the kernel. It changes when new buffers
4063f012e29Smrg	 * are allocated, freed, and moved. It cannot be larger than
4073f012e29Smrg	 * heap_size.
4083f012e29Smrg	 */
4093f012e29Smrg	uint64_t heap_usage;
4103f012e29Smrg
4113f012e29Smrg	/**
4123f012e29Smrg	 * Theoretical possible max. size of buffer which
4133f012e29Smrg	 * could be allocated in the given heap
4143f012e29Smrg	 */
4153f012e29Smrg	uint64_t max_allocation;
4163f012e29Smrg};
4173f012e29Smrg
4183f012e29Smrg/**
4193f012e29Smrg * Describe GPU h/w info needed for UMD correct initialization
4203f012e29Smrg *
4213f012e29Smrg * \sa amdgpu_query_gpu_info()
4223f012e29Smrg*/
4233f012e29Smrgstruct amdgpu_gpu_info {
4243f012e29Smrg	/** Asic id */
4253f012e29Smrg	uint32_t asic_id;
4263f012e29Smrg	/** Chip revision */
4273f012e29Smrg	uint32_t chip_rev;
4283f012e29Smrg	/** Chip external revision */
4293f012e29Smrg	uint32_t chip_external_rev;
4303f012e29Smrg	/** Family ID */
4313f012e29Smrg	uint32_t family_id;
4323f012e29Smrg	/** Special flags */
4333f012e29Smrg	uint64_t ids_flags;
4343f012e29Smrg	/** max engine clock*/
4353f012e29Smrg	uint64_t max_engine_clk;
4363f012e29Smrg	/** max memory clock */
4373f012e29Smrg	uint64_t max_memory_clk;
4383f012e29Smrg	/** number of shader engines */
4393f012e29Smrg	uint32_t num_shader_engines;
4403f012e29Smrg	/** number of shader arrays per engine */
4413f012e29Smrg	uint32_t num_shader_arrays_per_engine;
4423f012e29Smrg	/**  Number of available good shader pipes */
4433f012e29Smrg	uint32_t avail_quad_shader_pipes;
4443f012e29Smrg	/**  Max. number of shader pipes.(including good and bad pipes  */
4453f012e29Smrg	uint32_t max_quad_shader_pipes;
4463f012e29Smrg	/** Number of parameter cache entries per shader quad pipe */
4473f012e29Smrg	uint32_t cache_entries_per_quad_pipe;
4483f012e29Smrg	/**  Number of available graphics context */
4493f012e29Smrg	uint32_t num_hw_gfx_contexts;
4503f012e29Smrg	/** Number of render backend pipes */
4513f012e29Smrg	uint32_t rb_pipes;
4523f012e29Smrg	/**  Enabled render backend pipe mask */
4533f012e29Smrg	uint32_t enabled_rb_pipes_mask;
4543f012e29Smrg	/** Frequency of GPU Counter */
4553f012e29Smrg	uint32_t gpu_counter_freq;
4563f012e29Smrg	/** CC_RB_BACKEND_DISABLE.BACKEND_DISABLE per SE */
4573f012e29Smrg	uint32_t backend_disable[4];
4583f012e29Smrg	/** Value of MC_ARB_RAMCFG register*/
4593f012e29Smrg	uint32_t mc_arb_ramcfg;
4603f012e29Smrg	/** Value of GB_ADDR_CONFIG */
4613f012e29Smrg	uint32_t gb_addr_cfg;
4623f012e29Smrg	/** Values of the GB_TILE_MODE0..31 registers */
4633f012e29Smrg	uint32_t gb_tile_mode[32];
4643f012e29Smrg	/** Values of GB_MACROTILE_MODE0..15 registers */
4653f012e29Smrg	uint32_t gb_macro_tile_mode[16];
4663f012e29Smrg	/** Value of PA_SC_RASTER_CONFIG register per SE */
4673f012e29Smrg	uint32_t pa_sc_raster_cfg[4];
4683f012e29Smrg	/** Value of PA_SC_RASTER_CONFIG_1 register per SE */
4693f012e29Smrg	uint32_t pa_sc_raster_cfg1[4];
4703f012e29Smrg	/* CU info */
4713f012e29Smrg	uint32_t cu_active_number;
4723f012e29Smrg	uint32_t cu_ao_mask;
4733f012e29Smrg	uint32_t cu_bitmap[4][4];
4743f012e29Smrg	/* video memory type info*/
4753f012e29Smrg	uint32_t vram_type;
4763f012e29Smrg	/* video memory bit width*/
4773f012e29Smrg	uint32_t vram_bit_width;
4783f012e29Smrg	/** constant engine ram size*/
4793f012e29Smrg	uint32_t ce_ram_size;
4803f012e29Smrg	/* vce harvesting instance */
4813f012e29Smrg	uint32_t vce_harvest_config;
4823f012e29Smrg	/* PCI revision ID */
4833f012e29Smrg	uint32_t pci_rev_id;
4843f012e29Smrg};
4853f012e29Smrg
4863f012e29Smrg
4873f012e29Smrg/*--------------------------------------------------------------------------*/
4883f012e29Smrg/*------------------------- Functions --------------------------------------*/
4893f012e29Smrg/*--------------------------------------------------------------------------*/
4903f012e29Smrg
4913f012e29Smrg/*
4923f012e29Smrg * Initialization / Cleanup
4933f012e29Smrg *
4943f012e29Smrg*/
4953f012e29Smrg
4963f012e29Smrg/**
4973f012e29Smrg *
4983f012e29Smrg * \param   fd            - \c [in]  File descriptor for AMD GPU device
4993f012e29Smrg *                                   received previously as the result of
5003f012e29Smrg *                                   e.g. drmOpen() call.
5013f012e29Smrg *                                   For legacy fd type, the DRI2/DRI3
5023f012e29Smrg *                                   authentication should be done before
5033f012e29Smrg *                                   calling this function.
5043f012e29Smrg * \param   major_version - \c [out] Major version of library. It is assumed
5053f012e29Smrg *                                   that adding new functionality will cause
5063f012e29Smrg *                                   increase in major version
5073f012e29Smrg * \param   minor_version - \c [out] Minor version of library
5083f012e29Smrg * \param   device_handle - \c [out] Pointer to opaque context which should
5093f012e29Smrg *                                   be passed as the first parameter on each
5103f012e29Smrg *                                   API call
5113f012e29Smrg *
5123f012e29Smrg *
5133f012e29Smrg * \return   0 on success\n
5143f012e29Smrg *          <0 - Negative POSIX Error code
5153f012e29Smrg *
5163f012e29Smrg *
5173f012e29Smrg * \sa amdgpu_device_deinitialize()
5183f012e29Smrg*/
5193f012e29Smrgint amdgpu_device_initialize(int fd,
5203f012e29Smrg			     uint32_t *major_version,
5213f012e29Smrg			     uint32_t *minor_version,
5223f012e29Smrg			     amdgpu_device_handle *device_handle);
5233f012e29Smrg
5243f012e29Smrg/**
5253f012e29Smrg *
5263f012e29Smrg * When access to such library does not needed any more the special
5273f012e29Smrg * function must be call giving opportunity to clean up any
5283f012e29Smrg * resources if needed.
5293f012e29Smrg *
5303f012e29Smrg * \param   device_handle - \c [in]  Context associated with file
5313f012e29Smrg *                                   descriptor for AMD GPU device
5323f012e29Smrg *                                   received previously as the
5333f012e29Smrg *                                   result e.g. of drmOpen() call.
5343f012e29Smrg *
5353f012e29Smrg * \return  0 on success\n
5363f012e29Smrg *         <0 - Negative POSIX Error code
5373f012e29Smrg *
5383f012e29Smrg * \sa amdgpu_device_initialize()
5393f012e29Smrg *
5403f012e29Smrg*/
5413f012e29Smrgint amdgpu_device_deinitialize(amdgpu_device_handle device_handle);
5423f012e29Smrg
5433f012e29Smrg/*
5443f012e29Smrg * Memory Management
5453f012e29Smrg *
5463f012e29Smrg*/
5473f012e29Smrg
5483f012e29Smrg/**
5493f012e29Smrg * Allocate memory to be used by UMD for GPU related operations
5503f012e29Smrg *
5513f012e29Smrg * \param   dev		 - \c [in] Device handle.
5523f012e29Smrg *				   See #amdgpu_device_initialize()
5533f012e29Smrg * \param   alloc_buffer - \c [in] Pointer to the structure describing an
5543f012e29Smrg *				   allocation request
5553f012e29Smrg * \param   buf_handle	- \c [out] Allocated buffer handle
5563f012e29Smrg *
5573f012e29Smrg * \return   0 on success\n
5583f012e29Smrg *          <0 - Negative POSIX Error code
5593f012e29Smrg *
5603f012e29Smrg * \sa amdgpu_bo_free()
5613f012e29Smrg*/
5623f012e29Smrgint amdgpu_bo_alloc(amdgpu_device_handle dev,
5633f012e29Smrg		    struct amdgpu_bo_alloc_request *alloc_buffer,
5643f012e29Smrg		    amdgpu_bo_handle *buf_handle);
5653f012e29Smrg
5663f012e29Smrg/**
5673f012e29Smrg * Associate opaque data with buffer to be queried by another UMD
5683f012e29Smrg *
5693f012e29Smrg * \param   dev	       - \c [in] Device handle. See #amdgpu_device_initialize()
5703f012e29Smrg * \param   buf_handle - \c [in] Buffer handle
5713f012e29Smrg * \param   info       - \c [in] Metadata to associated with buffer
5723f012e29Smrg *
5733f012e29Smrg * \return   0 on success\n
5743f012e29Smrg *          <0 - Negative POSIX Error code
5753f012e29Smrg*/
5763f012e29Smrgint amdgpu_bo_set_metadata(amdgpu_bo_handle buf_handle,
5773f012e29Smrg			   struct amdgpu_bo_metadata *info);
5783f012e29Smrg
5793f012e29Smrg/**
5803f012e29Smrg * Query buffer information including metadata previusly associated with
5813f012e29Smrg * buffer.
5823f012e29Smrg *
5833f012e29Smrg * \param   dev	       - \c [in] Device handle.
5843f012e29Smrg *				 See #amdgpu_device_initialize()
5853f012e29Smrg * \param   buf_handle - \c [in]   Buffer handle
5863f012e29Smrg * \param   info       - \c [out]  Structure describing buffer
5873f012e29Smrg *
5883f012e29Smrg * \return   0 on success\n
5893f012e29Smrg *          <0 - Negative POSIX Error code
5903f012e29Smrg *
5913f012e29Smrg * \sa amdgpu_bo_set_metadata(), amdgpu_bo_alloc()
5923f012e29Smrg*/
5933f012e29Smrgint amdgpu_bo_query_info(amdgpu_bo_handle buf_handle,
5943f012e29Smrg			 struct amdgpu_bo_info *info);
5953f012e29Smrg
5963f012e29Smrg/**
5973f012e29Smrg * Allow others to get access to buffer
5983f012e29Smrg *
5993f012e29Smrg * \param   dev		  - \c [in] Device handle.
6003f012e29Smrg *				    See #amdgpu_device_initialize()
6013f012e29Smrg * \param   buf_handle    - \c [in] Buffer handle
6023f012e29Smrg * \param   type          - \c [in] Type of handle requested
6033f012e29Smrg * \param   shared_handle - \c [out] Special "shared" handle
6043f012e29Smrg *
6053f012e29Smrg * \return   0 on success\n
6063f012e29Smrg *          <0 - Negative POSIX Error code
6073f012e29Smrg *
6083f012e29Smrg * \sa amdgpu_bo_import()
6093f012e29Smrg *
6103f012e29Smrg*/
6113f012e29Smrgint amdgpu_bo_export(amdgpu_bo_handle buf_handle,
6123f012e29Smrg		     enum amdgpu_bo_handle_type type,
6133f012e29Smrg		     uint32_t *shared_handle);
6143f012e29Smrg
6153f012e29Smrg/**
6163f012e29Smrg * Request access to "shared" buffer
6173f012e29Smrg *
6183f012e29Smrg * \param   dev		  - \c [in] Device handle.
6193f012e29Smrg *				    See #amdgpu_device_initialize()
6203f012e29Smrg * \param   type	  - \c [in] Type of handle requested
6213f012e29Smrg * \param   shared_handle - \c [in] Shared handle received as result "import"
6223f012e29Smrg *				     operation
6233f012e29Smrg * \param   output        - \c [out] Pointer to structure with information
6243f012e29Smrg *				     about imported buffer
6253f012e29Smrg *
6263f012e29Smrg * \return   0 on success\n
6273f012e29Smrg *          <0 - Negative POSIX Error code
6283f012e29Smrg *
6293f012e29Smrg * \note  Buffer must be "imported" only using new "fd" (different from
6303f012e29Smrg *	  one used by "exporter").
6313f012e29Smrg *
6323f012e29Smrg * \sa amdgpu_bo_export()
6333f012e29Smrg *
6343f012e29Smrg*/
6353f012e29Smrgint amdgpu_bo_import(amdgpu_device_handle dev,
6363f012e29Smrg		     enum amdgpu_bo_handle_type type,
6373f012e29Smrg		     uint32_t shared_handle,
6383f012e29Smrg		     struct amdgpu_bo_import_result *output);
6393f012e29Smrg
6403f012e29Smrg/**
6413f012e29Smrg * Request GPU access to user allocated memory e.g. via "malloc"
6423f012e29Smrg *
6433f012e29Smrg * \param dev - [in] Device handle. See #amdgpu_device_initialize()
6443f012e29Smrg * \param cpu - [in] CPU address of user allocated memory which we
6453f012e29Smrg * want to map to GPU address space (make GPU accessible)
6463f012e29Smrg * (This address must be correctly aligned).
6473f012e29Smrg * \param size - [in] Size of allocation (must be correctly aligned)
6483f012e29Smrg * \param buf_handle - [out] Buffer handle for the userptr memory
6493f012e29Smrg * resource on submission and be used in other operations.
6503f012e29Smrg *
6513f012e29Smrg *
6523f012e29Smrg * \return   0 on success\n
6533f012e29Smrg *          <0 - Negative POSIX Error code
6543f012e29Smrg *
6553f012e29Smrg * \note
6563f012e29Smrg * This call doesn't guarantee that such memory will be persistently
6573f012e29Smrg * "locked" / make non-pageable. The purpose of this call is to provide
6583f012e29Smrg * opportunity for GPU get access to this resource during submission.
6593f012e29Smrg *
6603f012e29Smrg * The maximum amount of memory which could be mapped in this call depends
6613f012e29Smrg * if overcommit is disabled or not. If overcommit is disabled than the max.
6623f012e29Smrg * amount of memory to be pinned will be limited by left "free" size in total
6633f012e29Smrg * amount of memory which could be locked simultaneously ("GART" size).
6643f012e29Smrg *
6653f012e29Smrg * Supported (theoretical) max. size of mapping is restricted only by
6663f012e29Smrg * "GART" size.
6673f012e29Smrg *
6683f012e29Smrg * It is responsibility of caller to correctly specify access rights
6693f012e29Smrg * on VA assignment.
6703f012e29Smrg*/
6713f012e29Smrgint amdgpu_create_bo_from_user_mem(amdgpu_device_handle dev,
6723f012e29Smrg				    void *cpu, uint64_t size,
6733f012e29Smrg				    amdgpu_bo_handle *buf_handle);
6743f012e29Smrg
6753f012e29Smrg/**
6763f012e29Smrg * Free previosuly allocated memory
6773f012e29Smrg *
6783f012e29Smrg * \param   dev	       - \c [in] Device handle. See #amdgpu_device_initialize()
6793f012e29Smrg * \param   buf_handle - \c [in]  Buffer handle to free
6803f012e29Smrg *
6813f012e29Smrg * \return   0 on success\n
6823f012e29Smrg *          <0 - Negative POSIX Error code
6833f012e29Smrg *
6843f012e29Smrg * \note In the case of memory shared between different applications all
6853f012e29Smrg *	 resources will be “physically” freed only all such applications
6863f012e29Smrg *	 will be terminated
6873f012e29Smrg * \note If is UMD responsibility to ‘free’ buffer only when there is no
6883f012e29Smrg *	 more GPU access
6893f012e29Smrg *
6903f012e29Smrg * \sa amdgpu_bo_set_metadata(), amdgpu_bo_alloc()
6913f012e29Smrg *
6923f012e29Smrg*/
6933f012e29Smrgint amdgpu_bo_free(amdgpu_bo_handle buf_handle);
6943f012e29Smrg
6953f012e29Smrg/**
6963f012e29Smrg * Request CPU access to GPU accessible memory
6973f012e29Smrg *
6983f012e29Smrg * \param   buf_handle - \c [in] Buffer handle
6993f012e29Smrg * \param   cpu        - \c [out] CPU address to be used for access
7003f012e29Smrg *
7013f012e29Smrg * \return   0 on success\n
7023f012e29Smrg *          <0 - Negative POSIX Error code
7033f012e29Smrg *
7043f012e29Smrg * \sa amdgpu_bo_cpu_unmap()
7053f012e29Smrg *
7063f012e29Smrg*/
7073f012e29Smrgint amdgpu_bo_cpu_map(amdgpu_bo_handle buf_handle, void **cpu);
7083f012e29Smrg
7093f012e29Smrg/**
7103f012e29Smrg * Release CPU access to GPU memory
7113f012e29Smrg *
7123f012e29Smrg * \param   buf_handle  - \c [in] Buffer handle
7133f012e29Smrg *
7143f012e29Smrg * \return   0 on success\n
7153f012e29Smrg *          <0 - Negative POSIX Error code
7163f012e29Smrg *
7173f012e29Smrg * \sa amdgpu_bo_cpu_map()
7183f012e29Smrg *
7193f012e29Smrg*/
7203f012e29Smrgint amdgpu_bo_cpu_unmap(amdgpu_bo_handle buf_handle);
7213f012e29Smrg
7223f012e29Smrg/**
7233f012e29Smrg * Wait until a buffer is not used by the device.
7243f012e29Smrg *
7253f012e29Smrg * \param   dev           - \c [in] Device handle. See #amdgpu_device_initialize()
7263f012e29Smrg * \param   buf_handle    - \c [in] Buffer handle.
7273f012e29Smrg * \param   timeout_ns    - Timeout in nanoseconds.
7283f012e29Smrg * \param   buffer_busy   - 0 if buffer is idle, all GPU access was completed
7293f012e29Smrg *                            and no GPU access is scheduled.
7303f012e29Smrg *                          1 GPU access is in fly or scheduled
7313f012e29Smrg *
7323f012e29Smrg * \return   0 - on success
7333f012e29Smrg *          <0 - Negative POSIX Error code
7343f012e29Smrg */
7353f012e29Smrgint amdgpu_bo_wait_for_idle(amdgpu_bo_handle buf_handle,
7363f012e29Smrg			    uint64_t timeout_ns,
7373f012e29Smrg			    bool *buffer_busy);
7383f012e29Smrg
7393f012e29Smrg/**
7403f012e29Smrg * Creates a BO list handle for command submission.
7413f012e29Smrg *
7423f012e29Smrg * \param   dev			- \c [in] Device handle.
7433f012e29Smrg *				   See #amdgpu_device_initialize()
7443f012e29Smrg * \param   number_of_resources	- \c [in] Number of BOs in the list
7453f012e29Smrg * \param   resources		- \c [in] List of BO handles
7463f012e29Smrg * \param   resource_prios	- \c [in] Optional priority for each handle
7473f012e29Smrg * \param   result		- \c [out] Created BO list handle
7483f012e29Smrg *
7493f012e29Smrg * \return   0 on success\n
7503f012e29Smrg *          <0 - Negative POSIX Error code
7513f012e29Smrg *
7523f012e29Smrg * \sa amdgpu_bo_list_destroy()
7533f012e29Smrg*/
7543f012e29Smrgint amdgpu_bo_list_create(amdgpu_device_handle dev,
7553f012e29Smrg			  uint32_t number_of_resources,
7563f012e29Smrg			  amdgpu_bo_handle *resources,
7573f012e29Smrg			  uint8_t *resource_prios,
7583f012e29Smrg			  amdgpu_bo_list_handle *result);
7593f012e29Smrg
7603f012e29Smrg/**
7613f012e29Smrg * Destroys a BO list handle.
7623f012e29Smrg *
7633f012e29Smrg * \param   handle	- \c [in] BO list handle.
7643f012e29Smrg *
7653f012e29Smrg * \return   0 on success\n
7663f012e29Smrg *          <0 - Negative POSIX Error code
7673f012e29Smrg *
7683f012e29Smrg * \sa amdgpu_bo_list_create()
7693f012e29Smrg*/
7703f012e29Smrgint amdgpu_bo_list_destroy(amdgpu_bo_list_handle handle);
7713f012e29Smrg
7723f012e29Smrg/**
7733f012e29Smrg * Update resources for existing BO list
7743f012e29Smrg *
7753f012e29Smrg * \param   handle              - \c [in] BO list handle
7763f012e29Smrg * \param   number_of_resources - \c [in] Number of BOs in the list
7773f012e29Smrg * \param   resources           - \c [in] List of BO handles
7783f012e29Smrg * \param   resource_prios      - \c [in] Optional priority for each handle
7793f012e29Smrg *
7803f012e29Smrg * \return   0 on success\n
7813f012e29Smrg *          <0 - Negative POSIX Error code
7823f012e29Smrg *
7833f012e29Smrg * \sa amdgpu_bo_list_update()
7843f012e29Smrg*/
7853f012e29Smrgint amdgpu_bo_list_update(amdgpu_bo_list_handle handle,
7863f012e29Smrg			  uint32_t number_of_resources,
7873f012e29Smrg			  amdgpu_bo_handle *resources,
7883f012e29Smrg			  uint8_t *resource_prios);
7893f012e29Smrg
7903f012e29Smrg/*
7913f012e29Smrg * GPU Execution context
7923f012e29Smrg *
7933f012e29Smrg*/
7943f012e29Smrg
7953f012e29Smrg/**
7963f012e29Smrg * Create GPU execution Context
7973f012e29Smrg *
7983f012e29Smrg * For the purpose of GPU Scheduler and GPU Robustness extensions it is
7993f012e29Smrg * necessary to have information/identify rendering/compute contexts.
8003f012e29Smrg * It also may be needed to associate some specific requirements with such
8013f012e29Smrg * contexts.  Kernel driver will guarantee that submission from the same
8023f012e29Smrg * context will always be executed in order (first come, first serve).
8033f012e29Smrg *
8043f012e29Smrg *
80500a23bdaSmrg * \param   dev      - \c [in] Device handle. See #amdgpu_device_initialize()
80600a23bdaSmrg * \param   priority - \c [in] Context creation flags. See AMDGPU_CTX_PRIORITY_*
80700a23bdaSmrg * \param   context  - \c [out] GPU Context handle
8083f012e29Smrg *
8093f012e29Smrg * \return   0 on success\n
8103f012e29Smrg *          <0 - Negative POSIX Error code
8113f012e29Smrg *
8123f012e29Smrg * \sa amdgpu_cs_ctx_free()
8133f012e29Smrg *
8143f012e29Smrg*/
81500a23bdaSmrgint amdgpu_cs_ctx_create2(amdgpu_device_handle dev,
81600a23bdaSmrg			 uint32_t priority,
81700a23bdaSmrg			 amdgpu_context_handle *context);
81800a23bdaSmrg/**
81900a23bdaSmrg * Create GPU execution Context
82000a23bdaSmrg *
82100a23bdaSmrg * Refer to amdgpu_cs_ctx_create2 for full documentation. This call
82200a23bdaSmrg * is missing the priority parameter.
82300a23bdaSmrg *
82400a23bdaSmrg * \sa amdgpu_cs_ctx_create2()
82500a23bdaSmrg *
82600a23bdaSmrg*/
8273f012e29Smrgint amdgpu_cs_ctx_create(amdgpu_device_handle dev,
8283f012e29Smrg			 amdgpu_context_handle *context);
8293f012e29Smrg
8303f012e29Smrg/**
8313f012e29Smrg *
8323f012e29Smrg * Destroy GPU execution context when not needed any more
8333f012e29Smrg *
8343f012e29Smrg * \param   context - \c [in] GPU Context handle
8353f012e29Smrg *
8363f012e29Smrg * \return   0 on success\n
8373f012e29Smrg *          <0 - Negative POSIX Error code
8383f012e29Smrg *
8393f012e29Smrg * \sa amdgpu_cs_ctx_create()
8403f012e29Smrg *
8413f012e29Smrg*/
8423f012e29Smrgint amdgpu_cs_ctx_free(amdgpu_context_handle context);
8433f012e29Smrg
8443f012e29Smrg/**
8453f012e29Smrg * Query reset state for the specific GPU Context
8463f012e29Smrg *
8473f012e29Smrg * \param   context - \c [in]  GPU Context handle
8483f012e29Smrg * \param   state   - \c [out] One of AMDGPU_CTX_*_RESET
8493f012e29Smrg * \param   hangs   - \c [out] Number of hangs caused by the context.
8503f012e29Smrg *
8513f012e29Smrg * \return   0 on success\n
8523f012e29Smrg *          <0 - Negative POSIX Error code
8533f012e29Smrg *
8543f012e29Smrg * \sa amdgpu_cs_ctx_create()
8553f012e29Smrg *
8563f012e29Smrg*/
8573f012e29Smrgint amdgpu_cs_query_reset_state(amdgpu_context_handle context,
8583f012e29Smrg				uint32_t *state, uint32_t *hangs);
8593f012e29Smrg
8603f012e29Smrg/*
8613f012e29Smrg * Command Buffers Management
8623f012e29Smrg *
8633f012e29Smrg*/
8643f012e29Smrg
8653f012e29Smrg/**
8663f012e29Smrg * Send request to submit command buffers to hardware.
8673f012e29Smrg *
8683f012e29Smrg * Kernel driver could use GPU Scheduler to make decision when physically
8693f012e29Smrg * sent this request to the hardware. Accordingly this request could be put
8703f012e29Smrg * in queue and sent for execution later. The only guarantee is that request
8713f012e29Smrg * from the same GPU context to the same ip:ip_instance:ring will be executed in
8723f012e29Smrg * order.
8733f012e29Smrg *
8743f012e29Smrg * The caller can specify the user fence buffer/location with the fence_info in the
8753f012e29Smrg * cs_request.The sequence number is returned via the 'seq_no' parameter
8763f012e29Smrg * in ibs_request structure.
8773f012e29Smrg *
8783f012e29Smrg *
8793f012e29Smrg * \param   dev		       - \c [in]  Device handle.
8803f012e29Smrg *					  See #amdgpu_device_initialize()
8813f012e29Smrg * \param   context            - \c [in]  GPU Context
8823f012e29Smrg * \param   flags              - \c [in]  Global submission flags
8833f012e29Smrg * \param   ibs_request        - \c [in/out] Pointer to submission requests.
8843f012e29Smrg *					  We could submit to the several
8853f012e29Smrg *					  engines/rings simulteniously as
8863f012e29Smrg *					  'atomic' operation
8873f012e29Smrg * \param   number_of_requests - \c [in]  Number of submission requests
8883f012e29Smrg *
8893f012e29Smrg * \return   0 on success\n
8903f012e29Smrg *          <0 - Negative POSIX Error code
8913f012e29Smrg *
8923f012e29Smrg * \note It is required to pass correct resource list with buffer handles
8933f012e29Smrg *	 which will be accessible by command buffers from submission
8943f012e29Smrg *	 This will allow kernel driver to correctly implement "paging".
8953f012e29Smrg *	 Failure to do so will have unpredictable results.
8963f012e29Smrg *
8973f012e29Smrg * \sa amdgpu_command_buffer_alloc(), amdgpu_command_buffer_free(),
8983f012e29Smrg *     amdgpu_cs_query_fence_status()
8993f012e29Smrg *
9003f012e29Smrg*/
9013f012e29Smrgint amdgpu_cs_submit(amdgpu_context_handle context,
9023f012e29Smrg		     uint64_t flags,
9033f012e29Smrg		     struct amdgpu_cs_request *ibs_request,
9043f012e29Smrg		     uint32_t number_of_requests);
9053f012e29Smrg
9063f012e29Smrg/**
9073f012e29Smrg *  Query status of Command Buffer Submission
9083f012e29Smrg *
9093f012e29Smrg * \param   fence   - \c [in] Structure describing fence to query
9103f012e29Smrg * \param   timeout_ns - \c [in] Timeout value to wait
9113f012e29Smrg * \param   flags   - \c [in] Flags for the query
9123f012e29Smrg * \param   expired - \c [out] If fence expired or not.\n
9133f012e29Smrg *				0  – if fence is not expired\n
9143f012e29Smrg *				!0 - otherwise
9153f012e29Smrg *
9163f012e29Smrg * \return   0 on success\n
9173f012e29Smrg *          <0 - Negative POSIX Error code
9183f012e29Smrg *
9193f012e29Smrg * \note If UMD wants only to check operation status and returned immediately
9203f012e29Smrg *	 then timeout value as 0 must be passed. In this case success will be
9213f012e29Smrg *	 returned in the case if submission was completed or timeout error
9223f012e29Smrg *	 code.
9233f012e29Smrg *
9243f012e29Smrg * \sa amdgpu_cs_submit()
9253f012e29Smrg*/
9263f012e29Smrgint amdgpu_cs_query_fence_status(struct amdgpu_cs_fence *fence,
9273f012e29Smrg				 uint64_t timeout_ns,
9283f012e29Smrg				 uint64_t flags,
9293f012e29Smrg				 uint32_t *expired);
9303f012e29Smrg
931d8807b2fSmrg/**
932d8807b2fSmrg *  Wait for multiple fences
933d8807b2fSmrg *
934d8807b2fSmrg * \param   fences      - \c [in] The fence array to wait
935d8807b2fSmrg * \param   fence_count - \c [in] The fence count
936d8807b2fSmrg * \param   wait_all    - \c [in] If true, wait all fences to be signaled,
937d8807b2fSmrg *                                otherwise, wait at least one fence
938d8807b2fSmrg * \param   timeout_ns  - \c [in] The timeout to wait, in nanoseconds
939d8807b2fSmrg * \param   status      - \c [out] '1' for signaled, '0' for timeout
940d8807b2fSmrg * \param   first       - \c [out] the index of the first signaled fence from @fences
941d8807b2fSmrg *
942d8807b2fSmrg * \return  0 on success
943d8807b2fSmrg *          <0 - Negative POSIX Error code
944d8807b2fSmrg *
945d8807b2fSmrg * \note    Currently it supports only one amdgpu_device. All fences come from
946d8807b2fSmrg *          the same amdgpu_device with the same fd.
947d8807b2fSmrg*/
948d8807b2fSmrgint amdgpu_cs_wait_fences(struct amdgpu_cs_fence *fences,
949d8807b2fSmrg			  uint32_t fence_count,
950d8807b2fSmrg			  bool wait_all,
951d8807b2fSmrg			  uint64_t timeout_ns,
952d8807b2fSmrg			  uint32_t *status, uint32_t *first);
953d8807b2fSmrg
9543f012e29Smrg/*
9553f012e29Smrg * Query / Info API
9563f012e29Smrg *
9573f012e29Smrg*/
9583f012e29Smrg
9593f012e29Smrg/**
9603f012e29Smrg * Query allocation size alignments
9613f012e29Smrg *
9623f012e29Smrg * UMD should query information about GPU VM MC size alignments requirements
9633f012e29Smrg * to be able correctly choose required allocation size and implement
9643f012e29Smrg * internal optimization if needed.
9653f012e29Smrg *
9663f012e29Smrg * \param   dev  - \c [in] Device handle. See #amdgpu_device_initialize()
9673f012e29Smrg * \param   info - \c [out] Pointer to structure to get size alignment
9683f012e29Smrg *			  requirements
9693f012e29Smrg *
9703f012e29Smrg * \return   0 on success\n
9713f012e29Smrg *          <0 - Negative POSIX Error code
9723f012e29Smrg *
9733f012e29Smrg*/
9743f012e29Smrgint amdgpu_query_buffer_size_alignment(amdgpu_device_handle dev,
9753f012e29Smrg				       struct amdgpu_buffer_size_alignments
9763f012e29Smrg						*info);
9773f012e29Smrg
9783f012e29Smrg/**
9793f012e29Smrg * Query firmware versions
9803f012e29Smrg *
9813f012e29Smrg * \param   dev	        - \c [in] Device handle. See #amdgpu_device_initialize()
9823f012e29Smrg * \param   fw_type     - \c [in] AMDGPU_INFO_FW_*
9833f012e29Smrg * \param   ip_instance - \c [in] Index of the IP block of the same type.
9843f012e29Smrg * \param   index       - \c [in] Index of the engine. (for SDMA and MEC)
9853f012e29Smrg * \param   version     - \c [out] Pointer to to the "version" return value
9863f012e29Smrg * \param   feature     - \c [out] Pointer to to the "feature" return value
9873f012e29Smrg *
9883f012e29Smrg * \return   0 on success\n
9893f012e29Smrg *          <0 - Negative POSIX Error code
9903f012e29Smrg *
9913f012e29Smrg*/
9923f012e29Smrgint amdgpu_query_firmware_version(amdgpu_device_handle dev, unsigned fw_type,
9933f012e29Smrg				  unsigned ip_instance, unsigned index,
9943f012e29Smrg				  uint32_t *version, uint32_t *feature);
9953f012e29Smrg
9963f012e29Smrg/**
9973f012e29Smrg * Query the number of HW IP instances of a certain type.
9983f012e29Smrg *
9993f012e29Smrg * \param   dev      - \c [in] Device handle. See #amdgpu_device_initialize()
10003f012e29Smrg * \param   type     - \c [in] Hardware IP block type = AMDGPU_HW_IP_*
10013f012e29Smrg * \param   count    - \c [out] Pointer to structure to get information
10023f012e29Smrg *
10033f012e29Smrg * \return   0 on success\n
10043f012e29Smrg *          <0 - Negative POSIX Error code
10053f012e29Smrg*/
10063f012e29Smrgint amdgpu_query_hw_ip_count(amdgpu_device_handle dev, unsigned type,
10073f012e29Smrg			     uint32_t *count);
10083f012e29Smrg
10093f012e29Smrg/**
10103f012e29Smrg * Query engine information
10113f012e29Smrg *
10123f012e29Smrg * This query allows UMD to query information different engines and their
10133f012e29Smrg * capabilities.
10143f012e29Smrg *
10153f012e29Smrg * \param   dev         - \c [in] Device handle. See #amdgpu_device_initialize()
10163f012e29Smrg * \param   type        - \c [in] Hardware IP block type = AMDGPU_HW_IP_*
10173f012e29Smrg * \param   ip_instance - \c [in] Index of the IP block of the same type.
10183f012e29Smrg * \param   info        - \c [out] Pointer to structure to get information
10193f012e29Smrg *
10203f012e29Smrg * \return   0 on success\n
10213f012e29Smrg *          <0 - Negative POSIX Error code
10223f012e29Smrg*/
10233f012e29Smrgint amdgpu_query_hw_ip_info(amdgpu_device_handle dev, unsigned type,
10243f012e29Smrg			    unsigned ip_instance,
10253f012e29Smrg			    struct drm_amdgpu_info_hw_ip *info);
10263f012e29Smrg
10273f012e29Smrg/**
10283f012e29Smrg * Query heap information
10293f012e29Smrg *
10303f012e29Smrg * This query allows UMD to query potentially available memory resources and
10313f012e29Smrg * adjust their logic if necessary.
10323f012e29Smrg *
10333f012e29Smrg * \param   dev  - \c [in] Device handle. See #amdgpu_device_initialize()
10343f012e29Smrg * \param   heap - \c [in] Heap type
10353f012e29Smrg * \param   info - \c [in] Pointer to structure to get needed information
10363f012e29Smrg *
10373f012e29Smrg * \return   0 on success\n
10383f012e29Smrg *          <0 - Negative POSIX Error code
10393f012e29Smrg *
10403f012e29Smrg*/
10413f012e29Smrgint amdgpu_query_heap_info(amdgpu_device_handle dev, uint32_t heap,
10423f012e29Smrg			   uint32_t flags, struct amdgpu_heap_info *info);
10433f012e29Smrg
10443f012e29Smrg/**
10453f012e29Smrg * Get the CRTC ID from the mode object ID
10463f012e29Smrg *
10473f012e29Smrg * \param   dev    - \c [in] Device handle. See #amdgpu_device_initialize()
10483f012e29Smrg * \param   id     - \c [in] Mode object ID
10493f012e29Smrg * \param   result - \c [in] Pointer to the CRTC ID
10503f012e29Smrg *
10513f012e29Smrg * \return   0 on success\n
10523f012e29Smrg *          <0 - Negative POSIX Error code
10533f012e29Smrg *
10543f012e29Smrg*/
10553f012e29Smrgint amdgpu_query_crtc_from_id(amdgpu_device_handle dev, unsigned id,
10563f012e29Smrg			      int32_t *result);
10573f012e29Smrg
10583f012e29Smrg/**
10593f012e29Smrg * Query GPU H/w Info
10603f012e29Smrg *
10613f012e29Smrg * Query hardware specific information
10623f012e29Smrg *
10633f012e29Smrg * \param   dev  - \c [in] Device handle. See #amdgpu_device_initialize()
10643f012e29Smrg * \param   heap - \c [in] Heap type
10653f012e29Smrg * \param   info - \c [in] Pointer to structure to get needed information
10663f012e29Smrg *
10673f012e29Smrg * \return   0 on success\n
10683f012e29Smrg *          <0 - Negative POSIX Error code
10693f012e29Smrg *
10703f012e29Smrg*/
10713f012e29Smrgint amdgpu_query_gpu_info(amdgpu_device_handle dev,
10723f012e29Smrg			   struct amdgpu_gpu_info *info);
10733f012e29Smrg
10743f012e29Smrg/**
10753f012e29Smrg * Query hardware or driver information.
10763f012e29Smrg *
10773f012e29Smrg * The return size is query-specific and depends on the "info_id" parameter.
10783f012e29Smrg * No more than "size" bytes is returned.
10793f012e29Smrg *
10803f012e29Smrg * \param   dev     - \c [in] Device handle. See #amdgpu_device_initialize()
10813f012e29Smrg * \param   info_id - \c [in] AMDGPU_INFO_*
10823f012e29Smrg * \param   size    - \c [in] Size of the returned value.
10833f012e29Smrg * \param   value   - \c [out] Pointer to the return value.
10843f012e29Smrg *
10853f012e29Smrg * \return   0 on success\n
10863f012e29Smrg *          <0 - Negative POSIX error code
10873f012e29Smrg *
10883f012e29Smrg*/
10893f012e29Smrgint amdgpu_query_info(amdgpu_device_handle dev, unsigned info_id,
10903f012e29Smrg		      unsigned size, void *value);
10913f012e29Smrg
109200a23bdaSmrg/**
109300a23bdaSmrg * Query hardware or driver information.
109400a23bdaSmrg *
109500a23bdaSmrg * The return size is query-specific and depends on the "info_id" parameter.
109600a23bdaSmrg * No more than "size" bytes is returned.
109700a23bdaSmrg *
109800a23bdaSmrg * \param   dev     - \c [in] Device handle. See #amdgpu_device_initialize()
109900a23bdaSmrg * \param   info    - \c [in] amdgpu_sw_info_*
110000a23bdaSmrg * \param   value   - \c [out] Pointer to the return value.
110100a23bdaSmrg *
110200a23bdaSmrg * \return   0 on success\n
110300a23bdaSmrg *          <0 - Negative POSIX error code
110400a23bdaSmrg *
110500a23bdaSmrg*/
110600a23bdaSmrgint amdgpu_query_sw_info(amdgpu_device_handle dev, enum amdgpu_sw_info info,
110700a23bdaSmrg			 void *value);
110800a23bdaSmrg
11093f012e29Smrg/**
11103f012e29Smrg * Query information about GDS
11113f012e29Smrg *
11123f012e29Smrg * \param   dev	     - \c [in] Device handle. See #amdgpu_device_initialize()
11133f012e29Smrg * \param   gds_info - \c [out] Pointer to structure to get GDS information
11143f012e29Smrg *
11153f012e29Smrg * \return   0 on success\n
11163f012e29Smrg *          <0 - Negative POSIX Error code
11173f012e29Smrg *
11183f012e29Smrg*/
11193f012e29Smrgint amdgpu_query_gds_info(amdgpu_device_handle dev,
11203f012e29Smrg			struct amdgpu_gds_resource_info *gds_info);
11213f012e29Smrg
1122d8807b2fSmrg/**
1123d8807b2fSmrg * Query information about sensor.
1124d8807b2fSmrg *
1125d8807b2fSmrg * The return size is query-specific and depends on the "sensor_type"
1126d8807b2fSmrg * parameter. No more than "size" bytes is returned.
1127d8807b2fSmrg *
1128d8807b2fSmrg * \param   dev         - \c [in] Device handle. See #amdgpu_device_initialize()
1129d8807b2fSmrg * \param   sensor_type - \c [in] AMDGPU_INFO_SENSOR_*
1130d8807b2fSmrg * \param   size        - \c [in] Size of the returned value.
1131d8807b2fSmrg * \param   value       - \c [out] Pointer to the return value.
1132d8807b2fSmrg *
1133d8807b2fSmrg * \return   0 on success\n
1134d8807b2fSmrg *          <0 - Negative POSIX Error code
1135d8807b2fSmrg *
1136d8807b2fSmrg*/
1137d8807b2fSmrgint amdgpu_query_sensor_info(amdgpu_device_handle dev, unsigned sensor_type,
1138d8807b2fSmrg			     unsigned size, void *value);
1139d8807b2fSmrg
11403f012e29Smrg/**
11413f012e29Smrg * Read a set of consecutive memory-mapped registers.
11423f012e29Smrg * Not all registers are allowed to be read by userspace.
11433f012e29Smrg *
11443f012e29Smrg * \param   dev          - \c [in] Device handle. See #amdgpu_device_initialize(
11453f012e29Smrg * \param   dword_offset - \c [in] Register offset in dwords
11463f012e29Smrg * \param   count        - \c [in] The number of registers to read starting
11473f012e29Smrg *                                 from the offset
11483f012e29Smrg * \param   instance     - \c [in] GRBM_GFX_INDEX selector. It may have other
11493f012e29Smrg *                                 uses. Set it to 0xffffffff if unsure.
11503f012e29Smrg * \param   flags        - \c [in] Flags with additional information.
11513f012e29Smrg * \param   values       - \c [out] The pointer to return values.
11523f012e29Smrg *
11533f012e29Smrg * \return   0 on success\n
11543f012e29Smrg *          <0 - Negative POSIX error code
11553f012e29Smrg *
11563f012e29Smrg*/
11573f012e29Smrgint amdgpu_read_mm_registers(amdgpu_device_handle dev, unsigned dword_offset,
11583f012e29Smrg			     unsigned count, uint32_t instance, uint32_t flags,
11593f012e29Smrg			     uint32_t *values);
11603f012e29Smrg
11613f012e29Smrg/**
11623f012e29Smrg * Flag to request VA address range in the 32bit address space
11633f012e29Smrg*/
11643f012e29Smrg#define AMDGPU_VA_RANGE_32_BIT		0x1
116500a23bdaSmrg#define AMDGPU_VA_RANGE_HIGH		0x2
11663f012e29Smrg
11673f012e29Smrg/**
11683f012e29Smrg * Allocate virtual address range
11693f012e29Smrg *
11703f012e29Smrg * \param dev - [in] Device handle. See #amdgpu_device_initialize()
11713f012e29Smrg * \param va_range_type - \c [in] Type of MC va range from which to allocate
11723f012e29Smrg * \param size - \c [in] Size of range. Size must be correctly* aligned.
11733f012e29Smrg * It is client responsibility to correctly aligned size based on the future
11743f012e29Smrg * usage of allocated range.
11753f012e29Smrg * \param va_base_alignment - \c [in] Overwrite base address alignment
11763f012e29Smrg * requirement for GPU VM MC virtual
11773f012e29Smrg * address assignment. Must be multiple of size alignments received as
11783f012e29Smrg * 'amdgpu_buffer_size_alignments'.
11793f012e29Smrg * If 0 use the default one.
11803f012e29Smrg * \param va_base_required - \c [in] Specified required va base address.
11813f012e29Smrg * If 0 then library choose available one.
11823f012e29Smrg * If !0 value will be passed and those value already "in use" then
11833f012e29Smrg * corresponding error status will be returned.
11843f012e29Smrg * \param va_base_allocated - \c [out] On return: Allocated VA base to be used
11853f012e29Smrg * by client.
11863f012e29Smrg * \param va_range_handle - \c [out] On return: Handle assigned to allocation
11873f012e29Smrg * \param flags - \c [in] flags for special VA range
11883f012e29Smrg *
11893f012e29Smrg * \return 0 on success\n
11903f012e29Smrg * >0 - AMD specific error code\n
11913f012e29Smrg * <0 - Negative POSIX Error code
11923f012e29Smrg *
11933f012e29Smrg * \notes \n
11943f012e29Smrg * It is client responsibility to correctly handle VA assignments and usage.
11953f012e29Smrg * Neither kernel driver nor libdrm_amdpgu are able to prevent and
11963f012e29Smrg * detect wrong va assignemnt.
11973f012e29Smrg *
11983f012e29Smrg * It is client responsibility to correctly handle multi-GPU cases and to pass
11993f012e29Smrg * the corresponding arrays of all devices handles where corresponding VA will
12003f012e29Smrg * be used.
12013f012e29Smrg *
12023f012e29Smrg*/
12033f012e29Smrgint amdgpu_va_range_alloc(amdgpu_device_handle dev,
12043f012e29Smrg			   enum amdgpu_gpu_va_range va_range_type,
12053f012e29Smrg			   uint64_t size,
12063f012e29Smrg			   uint64_t va_base_alignment,
12073f012e29Smrg			   uint64_t va_base_required,
12083f012e29Smrg			   uint64_t *va_base_allocated,
12093f012e29Smrg			   amdgpu_va_handle *va_range_handle,
12103f012e29Smrg			   uint64_t flags);
12113f012e29Smrg
12123f012e29Smrg/**
12133f012e29Smrg * Free previously allocated virtual address range
12143f012e29Smrg *
12153f012e29Smrg *
12163f012e29Smrg * \param va_range_handle - \c [in] Handle assigned to VA allocation
12173f012e29Smrg *
12183f012e29Smrg * \return 0 on success\n
12193f012e29Smrg * >0 - AMD specific error code\n
12203f012e29Smrg * <0 - Negative POSIX Error code
12213f012e29Smrg *
12223f012e29Smrg*/
12233f012e29Smrgint amdgpu_va_range_free(amdgpu_va_handle va_range_handle);
12243f012e29Smrg
12253f012e29Smrg/**
12263f012e29Smrg* Query virtual address range
12273f012e29Smrg*
12283f012e29Smrg* UMD can query GPU VM range supported by each device
12293f012e29Smrg* to initialize its own VAM accordingly.
12303f012e29Smrg*
12313f012e29Smrg* \param   dev    - [in] Device handle. See #amdgpu_device_initialize()
12323f012e29Smrg* \param   type   - \c [in] Type of virtual address range
12333f012e29Smrg* \param   offset - \c [out] Start offset of virtual address range
12343f012e29Smrg* \param   size   - \c [out] Size of virtual address range
12353f012e29Smrg*
12363f012e29Smrg* \return   0 on success\n
12373f012e29Smrg*          <0 - Negative POSIX Error code
12383f012e29Smrg*
12393f012e29Smrg*/
12403f012e29Smrg
12413f012e29Smrgint amdgpu_va_range_query(amdgpu_device_handle dev,
12423f012e29Smrg			  enum amdgpu_gpu_va_range type,
12433f012e29Smrg			  uint64_t *start,
12443f012e29Smrg			  uint64_t *end);
12453f012e29Smrg
12463f012e29Smrg/**
12473f012e29Smrg *  VA mapping/unmapping for the buffer object
12483f012e29Smrg *
12493f012e29Smrg * \param  bo		- \c [in] BO handle
12503f012e29Smrg * \param  offset	- \c [in] Start offset to map
12513f012e29Smrg * \param  size		- \c [in] Size to map
12523f012e29Smrg * \param  addr		- \c [in] Start virtual address.
12533f012e29Smrg * \param  flags	- \c [in] Supported flags for mapping/unmapping
12543f012e29Smrg * \param  ops		- \c [in] AMDGPU_VA_OP_MAP or AMDGPU_VA_OP_UNMAP
12553f012e29Smrg *
12563f012e29Smrg * \return   0 on success\n
12573f012e29Smrg *          <0 - Negative POSIX Error code
12583f012e29Smrg *
12593f012e29Smrg*/
12603f012e29Smrg
12613f012e29Smrgint amdgpu_bo_va_op(amdgpu_bo_handle bo,
12623f012e29Smrg		    uint64_t offset,
12633f012e29Smrg		    uint64_t size,
12643f012e29Smrg		    uint64_t addr,
12653f012e29Smrg		    uint64_t flags,
12663f012e29Smrg		    uint32_t ops);
12673f012e29Smrg
1268d8807b2fSmrg/**
1269d8807b2fSmrg *  VA mapping/unmapping for a buffer object or PRT region.
1270d8807b2fSmrg *
1271d8807b2fSmrg * This is not a simple drop-in extension for amdgpu_bo_va_op; instead, all
1272d8807b2fSmrg * parameters are treated "raw", i.e. size is not automatically aligned, and
1273d8807b2fSmrg * all flags must be specified explicitly.
1274d8807b2fSmrg *
1275d8807b2fSmrg * \param  dev		- \c [in] device handle
1276d8807b2fSmrg * \param  bo		- \c [in] BO handle (may be NULL)
1277d8807b2fSmrg * \param  offset	- \c [in] Start offset to map
1278d8807b2fSmrg * \param  size		- \c [in] Size to map
1279d8807b2fSmrg * \param  addr		- \c [in] Start virtual address.
1280d8807b2fSmrg * \param  flags	- \c [in] Supported flags for mapping/unmapping
1281d8807b2fSmrg * \param  ops		- \c [in] AMDGPU_VA_OP_MAP or AMDGPU_VA_OP_UNMAP
1282d8807b2fSmrg *
1283d8807b2fSmrg * \return   0 on success\n
1284d8807b2fSmrg *          <0 - Negative POSIX Error code
1285d8807b2fSmrg *
1286d8807b2fSmrg*/
1287d8807b2fSmrg
1288d8807b2fSmrgint amdgpu_bo_va_op_raw(amdgpu_device_handle dev,
1289d8807b2fSmrg			amdgpu_bo_handle bo,
1290d8807b2fSmrg			uint64_t offset,
1291d8807b2fSmrg			uint64_t size,
1292d8807b2fSmrg			uint64_t addr,
1293d8807b2fSmrg			uint64_t flags,
1294d8807b2fSmrg			uint32_t ops);
1295d8807b2fSmrg
12963f012e29Smrg/**
12973f012e29Smrg *  create semaphore
12983f012e29Smrg *
12993f012e29Smrg * \param   sem	   - \c [out] semaphore handle
13003f012e29Smrg *
13013f012e29Smrg * \return   0 on success\n
13023f012e29Smrg *          <0 - Negative POSIX Error code
13033f012e29Smrg *
13043f012e29Smrg*/
13053f012e29Smrgint amdgpu_cs_create_semaphore(amdgpu_semaphore_handle *sem);
13063f012e29Smrg
13073f012e29Smrg/**
13083f012e29Smrg *  signal semaphore
13093f012e29Smrg *
13103f012e29Smrg * \param   context        - \c [in] GPU Context
13113f012e29Smrg * \param   ip_type        - \c [in] Hardware IP block type = AMDGPU_HW_IP_*
13123f012e29Smrg * \param   ip_instance    - \c [in] Index of the IP block of the same type
13133f012e29Smrg * \param   ring           - \c [in] Specify ring index of the IP
13143f012e29Smrg * \param   sem	           - \c [in] semaphore handle
13153f012e29Smrg *
13163f012e29Smrg * \return   0 on success\n
13173f012e29Smrg *          <0 - Negative POSIX Error code
13183f012e29Smrg *
13193f012e29Smrg*/
13203f012e29Smrgint amdgpu_cs_signal_semaphore(amdgpu_context_handle ctx,
13213f012e29Smrg			       uint32_t ip_type,
13223f012e29Smrg			       uint32_t ip_instance,
13233f012e29Smrg			       uint32_t ring,
13243f012e29Smrg			       amdgpu_semaphore_handle sem);
13253f012e29Smrg
13263f012e29Smrg/**
13273f012e29Smrg *  wait semaphore
13283f012e29Smrg *
13293f012e29Smrg * \param   context        - \c [in] GPU Context
13303f012e29Smrg * \param   ip_type        - \c [in] Hardware IP block type = AMDGPU_HW_IP_*
13313f012e29Smrg * \param   ip_instance    - \c [in] Index of the IP block of the same type
13323f012e29Smrg * \param   ring           - \c [in] Specify ring index of the IP
13333f012e29Smrg * \param   sem	           - \c [in] semaphore handle
13343f012e29Smrg *
13353f012e29Smrg * \return   0 on success\n
13363f012e29Smrg *          <0 - Negative POSIX Error code
13373f012e29Smrg *
13383f012e29Smrg*/
13393f012e29Smrgint amdgpu_cs_wait_semaphore(amdgpu_context_handle ctx,
13403f012e29Smrg			     uint32_t ip_type,
13413f012e29Smrg			     uint32_t ip_instance,
13423f012e29Smrg			     uint32_t ring,
13433f012e29Smrg			     amdgpu_semaphore_handle sem);
13443f012e29Smrg
13453f012e29Smrg/**
13463f012e29Smrg *  destroy semaphore
13473f012e29Smrg *
13483f012e29Smrg * \param   sem	    - \c [in] semaphore handle
13493f012e29Smrg *
13503f012e29Smrg * \return   0 on success\n
13513f012e29Smrg *          <0 - Negative POSIX Error code
13523f012e29Smrg *
13533f012e29Smrg*/
13543f012e29Smrgint amdgpu_cs_destroy_semaphore(amdgpu_semaphore_handle sem);
13553f012e29Smrg
1356037b3c26Smrg/**
1357037b3c26Smrg *  Get the ASIC marketing name
1358037b3c26Smrg *
1359037b3c26Smrg * \param   dev         - \c [in] Device handle. See #amdgpu_device_initialize()
1360037b3c26Smrg *
1361037b3c26Smrg * \return  the constant string of the marketing name
1362037b3c26Smrg *          "NULL" means the ASIC is not found
1363037b3c26Smrg*/
1364037b3c26Smrgconst char *amdgpu_get_marketing_name(amdgpu_device_handle dev);
1365037b3c26Smrg
136600a23bdaSmrg/**
136700a23bdaSmrg *  Create kernel sync object
136800a23bdaSmrg *
136900a23bdaSmrg * \param   dev         - \c [in]  device handle
137000a23bdaSmrg * \param   flags       - \c [in]  flags that affect creation
137100a23bdaSmrg * \param   syncobj     - \c [out] sync object handle
137200a23bdaSmrg *
137300a23bdaSmrg * \return   0 on success\n
137400a23bdaSmrg *          <0 - Negative POSIX Error code
137500a23bdaSmrg *
137600a23bdaSmrg*/
137700a23bdaSmrgint amdgpu_cs_create_syncobj2(amdgpu_device_handle dev,
137800a23bdaSmrg			      uint32_t  flags,
137900a23bdaSmrg			      uint32_t *syncobj);
138000a23bdaSmrg
1381d8807b2fSmrg/**
1382d8807b2fSmrg *  Create kernel sync object
1383d8807b2fSmrg *
1384d8807b2fSmrg * \param   dev	      - \c [in]  device handle
1385d8807b2fSmrg * \param   syncobj   - \c [out] sync object handle
1386d8807b2fSmrg *
1387d8807b2fSmrg * \return   0 on success\n
1388d8807b2fSmrg *          <0 - Negative POSIX Error code
1389d8807b2fSmrg *
1390d8807b2fSmrg*/
1391d8807b2fSmrgint amdgpu_cs_create_syncobj(amdgpu_device_handle dev,
1392d8807b2fSmrg			     uint32_t *syncobj);
1393d8807b2fSmrg/**
1394d8807b2fSmrg *  Destroy kernel sync object
1395d8807b2fSmrg *
1396d8807b2fSmrg * \param   dev	    - \c [in] device handle
1397d8807b2fSmrg * \param   syncobj - \c [in] sync object handle
1398d8807b2fSmrg *
1399d8807b2fSmrg * \return   0 on success\n
1400d8807b2fSmrg *          <0 - Negative POSIX Error code
1401d8807b2fSmrg *
1402d8807b2fSmrg*/
1403d8807b2fSmrgint amdgpu_cs_destroy_syncobj(amdgpu_device_handle dev,
1404d8807b2fSmrg			      uint32_t syncobj);
1405d8807b2fSmrg
140600a23bdaSmrg/**
140700a23bdaSmrg * Reset kernel sync objects to unsignalled state.
140800a23bdaSmrg *
140900a23bdaSmrg * \param dev           - \c [in] device handle
141000a23bdaSmrg * \param syncobjs      - \c [in] array of sync object handles
141100a23bdaSmrg * \param syncobj_count - \c [in] number of handles in syncobjs
141200a23bdaSmrg *
141300a23bdaSmrg * \return   0 on success\n
141400a23bdaSmrg *          <0 - Negative POSIX Error code
141500a23bdaSmrg *
141600a23bdaSmrg*/
141700a23bdaSmrgint amdgpu_cs_syncobj_reset(amdgpu_device_handle dev,
141800a23bdaSmrg			    const uint32_t *syncobjs, uint32_t syncobj_count);
141900a23bdaSmrg
142000a23bdaSmrg/**
142100a23bdaSmrg * Signal kernel sync objects.
142200a23bdaSmrg *
142300a23bdaSmrg * \param dev           - \c [in] device handle
142400a23bdaSmrg * \param syncobjs      - \c [in] array of sync object handles
142500a23bdaSmrg * \param syncobj_count - \c [in] number of handles in syncobjs
142600a23bdaSmrg *
142700a23bdaSmrg * \return   0 on success\n
142800a23bdaSmrg *          <0 - Negative POSIX Error code
142900a23bdaSmrg *
143000a23bdaSmrg*/
143100a23bdaSmrgint amdgpu_cs_syncobj_signal(amdgpu_device_handle dev,
143200a23bdaSmrg			     const uint32_t *syncobjs, uint32_t syncobj_count);
143300a23bdaSmrg
143400a23bdaSmrg/**
143500a23bdaSmrg *  Wait for one or all sync objects to signal.
143600a23bdaSmrg *
143700a23bdaSmrg * \param   dev	    - \c [in] self-explanatory
143800a23bdaSmrg * \param   handles - \c [in] array of sync object handles
143900a23bdaSmrg * \param   num_handles - \c [in] self-explanatory
144000a23bdaSmrg * \param   timeout_nsec - \c [in] self-explanatory
144100a23bdaSmrg * \param   flags   - \c [in] a bitmask of DRM_SYNCOBJ_WAIT_FLAGS_*
144200a23bdaSmrg * \param   first_signaled - \c [in] self-explanatory
144300a23bdaSmrg *
144400a23bdaSmrg * \return   0 on success\n
144500a23bdaSmrg *          -ETIME - Timeout
144600a23bdaSmrg *          <0 - Negative POSIX Error code
144700a23bdaSmrg *
144800a23bdaSmrg */
144900a23bdaSmrgint amdgpu_cs_syncobj_wait(amdgpu_device_handle dev,
145000a23bdaSmrg			   uint32_t *handles, unsigned num_handles,
145100a23bdaSmrg			   int64_t timeout_nsec, unsigned flags,
145200a23bdaSmrg			   uint32_t *first_signaled);
145300a23bdaSmrg
1454d8807b2fSmrg/**
1455d8807b2fSmrg *  Export kernel sync object to shareable fd.
1456d8807b2fSmrg *
1457d8807b2fSmrg * \param   dev	       - \c [in] device handle
1458d8807b2fSmrg * \param   syncobj    - \c [in] sync object handle
1459d8807b2fSmrg * \param   shared_fd  - \c [out] shared file descriptor.
1460d8807b2fSmrg *
1461d8807b2fSmrg * \return   0 on success\n
1462d8807b2fSmrg *          <0 - Negative POSIX Error code
1463d8807b2fSmrg *
1464d8807b2fSmrg*/
1465d8807b2fSmrgint amdgpu_cs_export_syncobj(amdgpu_device_handle dev,
1466d8807b2fSmrg			     uint32_t syncobj,
1467d8807b2fSmrg			     int *shared_fd);
1468d8807b2fSmrg/**
1469d8807b2fSmrg *  Import kernel sync object from shareable fd.
1470d8807b2fSmrg *
1471d8807b2fSmrg * \param   dev	       - \c [in] device handle
1472d8807b2fSmrg * \param   shared_fd  - \c [in] shared file descriptor.
1473d8807b2fSmrg * \param   syncobj    - \c [out] sync object handle
1474d8807b2fSmrg *
1475d8807b2fSmrg * \return   0 on success\n
1476d8807b2fSmrg *          <0 - Negative POSIX Error code
1477d8807b2fSmrg *
1478d8807b2fSmrg*/
1479d8807b2fSmrgint amdgpu_cs_import_syncobj(amdgpu_device_handle dev,
1480d8807b2fSmrg			     int shared_fd,
1481d8807b2fSmrg			     uint32_t *syncobj);
1482d8807b2fSmrg
148300a23bdaSmrg/**
148400a23bdaSmrg *  Export kernel sync object to a sync_file.
148500a23bdaSmrg *
148600a23bdaSmrg * \param   dev	       - \c [in] device handle
148700a23bdaSmrg * \param   syncobj    - \c [in] sync object handle
148800a23bdaSmrg * \param   sync_file_fd - \c [out] sync_file file descriptor.
148900a23bdaSmrg *
149000a23bdaSmrg * \return   0 on success\n
149100a23bdaSmrg *          <0 - Negative POSIX Error code
149200a23bdaSmrg *
149300a23bdaSmrg */
149400a23bdaSmrgint amdgpu_cs_syncobj_export_sync_file(amdgpu_device_handle dev,
149500a23bdaSmrg				       uint32_t syncobj,
149600a23bdaSmrg				       int *sync_file_fd);
149700a23bdaSmrg
149800a23bdaSmrg/**
149900a23bdaSmrg *  Import kernel sync object from a sync_file.
150000a23bdaSmrg *
150100a23bdaSmrg * \param   dev	       - \c [in] device handle
150200a23bdaSmrg * \param   syncobj    - \c [in] sync object handle
150300a23bdaSmrg * \param   sync_file_fd - \c [in] sync_file file descriptor.
150400a23bdaSmrg *
150500a23bdaSmrg * \return   0 on success\n
150600a23bdaSmrg *          <0 - Negative POSIX Error code
150700a23bdaSmrg *
150800a23bdaSmrg */
150900a23bdaSmrgint amdgpu_cs_syncobj_import_sync_file(amdgpu_device_handle dev,
151000a23bdaSmrg				       uint32_t syncobj,
151100a23bdaSmrg				       int sync_file_fd);
151200a23bdaSmrg
151300a23bdaSmrg/**
151400a23bdaSmrg * Export an amdgpu fence as a handle (syncobj or fd).
151500a23bdaSmrg *
151600a23bdaSmrg * \param what		AMDGPU_FENCE_TO_HANDLE_GET_{SYNCOBJ, FD}
151700a23bdaSmrg * \param out_handle	returned handle
151800a23bdaSmrg *
151900a23bdaSmrg * \return   0 on success\n
152000a23bdaSmrg *          <0 - Negative POSIX Error code
152100a23bdaSmrg */
152200a23bdaSmrgint amdgpu_cs_fence_to_handle(amdgpu_device_handle dev,
152300a23bdaSmrg			      struct amdgpu_cs_fence *fence,
152400a23bdaSmrg			      uint32_t what,
152500a23bdaSmrg			      uint32_t *out_handle);
152600a23bdaSmrg
1527d8807b2fSmrg/**
1528d8807b2fSmrg *  Submit raw command submission to kernel
1529d8807b2fSmrg *
1530d8807b2fSmrg * \param   dev	       - \c [in] device handle
1531d8807b2fSmrg * \param   context    - \c [in] context handle for context id
1532d8807b2fSmrg * \param   bo_list_handle - \c [in] request bo list handle (0 for none)
1533d8807b2fSmrg * \param   num_chunks - \c [in] number of CS chunks to submit
1534d8807b2fSmrg * \param   chunks     - \c [in] array of CS chunks
1535d8807b2fSmrg * \param   seq_no     - \c [out] output sequence number for submission.
1536d8807b2fSmrg *
1537d8807b2fSmrg * \return   0 on success\n
1538d8807b2fSmrg *          <0 - Negative POSIX Error code
1539d8807b2fSmrg *
1540d8807b2fSmrg */
1541d8807b2fSmrgstruct drm_amdgpu_cs_chunk;
1542d8807b2fSmrgstruct drm_amdgpu_cs_chunk_dep;
1543d8807b2fSmrgstruct drm_amdgpu_cs_chunk_data;
1544d8807b2fSmrg
1545d8807b2fSmrgint amdgpu_cs_submit_raw(amdgpu_device_handle dev,
1546d8807b2fSmrg			 amdgpu_context_handle context,
1547d8807b2fSmrg			 amdgpu_bo_list_handle bo_list_handle,
1548d8807b2fSmrg			 int num_chunks,
1549d8807b2fSmrg			 struct drm_amdgpu_cs_chunk *chunks,
1550d8807b2fSmrg			 uint64_t *seq_no);
1551d8807b2fSmrg
1552d8807b2fSmrgvoid amdgpu_cs_chunk_fence_to_dep(struct amdgpu_cs_fence *fence,
1553d8807b2fSmrg				  struct drm_amdgpu_cs_chunk_dep *dep);
1554d8807b2fSmrgvoid amdgpu_cs_chunk_fence_info_to_data(struct amdgpu_cs_fence_info *fence_info,
1555d8807b2fSmrg					struct drm_amdgpu_cs_chunk_data *data);
1556d8807b2fSmrg
155700a23bdaSmrg/**
155800a23bdaSmrg * Reserve VMID
155900a23bdaSmrg * \param   context - \c [in]  GPU Context
156000a23bdaSmrg * \param   flags - \c [in]  TBD
156100a23bdaSmrg *
156200a23bdaSmrg * \return  0 on success otherwise POSIX Error code
156300a23bdaSmrg*/
156400a23bdaSmrgint amdgpu_vm_reserve_vmid(amdgpu_device_handle dev, uint32_t flags);
156500a23bdaSmrg
156600a23bdaSmrg/**
156700a23bdaSmrg * Free reserved VMID
156800a23bdaSmrg * \param   context - \c [in]  GPU Context
156900a23bdaSmrg * \param   flags - \c [in]  TBD
157000a23bdaSmrg *
157100a23bdaSmrg * \return  0 on success otherwise POSIX Error code
157200a23bdaSmrg*/
157300a23bdaSmrgint amdgpu_vm_unreserve_vmid(amdgpu_device_handle dev, uint32_t flags);
157400a23bdaSmrg
1575d8807b2fSmrg#ifdef __cplusplus
1576d8807b2fSmrg}
1577d8807b2fSmrg#endif
15783f012e29Smrg#endif /* #ifdef _AMDGPU_H_ */
1579