1 /* amdgpu_drm.h -- Public header for the amdgpu driver -*- linux-c -*-
3 * Copyright 2000 Precision Insight, Inc., Cedar Park, Texas.
4 * Copyright 2000 VA Linux Systems, Inc., Fremont, California.
5 * Copyright 2002 Tungsten Graphics, Inc., Cedar Park, Texas.
6 * Copyright 2014 Advanced Micro Devices, Inc.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
27 * Kevin E. Martin <martin@valinux.com>
28 * Gareth Hughes <gareth@valinux.com>
29 * Keith Whitwell <keith@tungstengraphics.com>
32 #ifndef __AMDGPU_DRM_H__
33 #define __AMDGPU_DRM_H__
37 #define DRM_AMDGPU_GEM_CREATE 0x00
38 #define DRM_AMDGPU_GEM_MMAP 0x01
39 #define DRM_AMDGPU_CTX 0x02
40 #define DRM_AMDGPU_BO_LIST 0x03
41 #define DRM_AMDGPU_CS 0x04
42 #define DRM_AMDGPU_INFO 0x05
43 #define DRM_AMDGPU_GEM_METADATA 0x06
44 #define DRM_AMDGPU_GEM_WAIT_IDLE 0x07
45 #define DRM_AMDGPU_GEM_VA 0x08
46 #define DRM_AMDGPU_WAIT_CS 0x09
47 #define DRM_AMDGPU_GEM_OP 0x10
48 #define DRM_AMDGPU_GEM_USERPTR 0x11
50 #define DRM_IOCTL_AMDGPU_GEM_CREATE DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_CREATE, union drm_amdgpu_gem_create)
51 #define DRM_IOCTL_AMDGPU_GEM_MMAP DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_MMAP, union drm_amdgpu_gem_mmap)
52 #define DRM_IOCTL_AMDGPU_CTX DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_CTX, union drm_amdgpu_ctx)
53 #define DRM_IOCTL_AMDGPU_BO_LIST DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_BO_LIST, union drm_amdgpu_bo_list)
54 #define DRM_IOCTL_AMDGPU_CS DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_CS, union drm_amdgpu_cs)
55 #define DRM_IOCTL_AMDGPU_INFO DRM_IOW(DRM_COMMAND_BASE + DRM_AMDGPU_INFO, struct drm_amdgpu_info)
56 #define DRM_IOCTL_AMDGPU_GEM_METADATA DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_METADATA, struct drm_amdgpu_gem_metadata)
57 #define DRM_IOCTL_AMDGPU_GEM_WAIT_IDLE DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_WAIT_IDLE, union drm_amdgpu_gem_wait_idle)
58 #define DRM_IOCTL_AMDGPU_GEM_VA DRM_IOW(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_VA, struct drm_amdgpu_gem_va)
59 #define DRM_IOCTL_AMDGPU_WAIT_CS DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_WAIT_CS, union drm_amdgpu_wait_cs)
60 #define DRM_IOCTL_AMDGPU_GEM_OP DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_OP, struct drm_amdgpu_gem_op)
61 #define DRM_IOCTL_AMDGPU_GEM_USERPTR DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_USERPTR, struct drm_amdgpu_gem_userptr)
63 #define AMDGPU_GEM_DOMAIN_CPU 0x1
64 #define AMDGPU_GEM_DOMAIN_GTT 0x2
65 #define AMDGPU_GEM_DOMAIN_VRAM 0x4
66 #define AMDGPU_GEM_DOMAIN_GDS 0x8
67 #define AMDGPU_GEM_DOMAIN_GWS 0x10
68 #define AMDGPU_GEM_DOMAIN_OA 0x20
70 /* Flag that CPU access will be required for the case of VRAM domain */
71 #define AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED (1 << 0)
72 /* Flag that CPU access will not work, this VRAM domain is invisible */
73 #define AMDGPU_GEM_CREATE_NO_CPU_ACCESS (1 << 1)
74 /* Flag that USWC attributes should be used for GTT */
75 #define AMDGPU_GEM_CREATE_CPU_GTT_USWC (1 << 2)
77 struct drm_amdgpu_gem_create_in
{
78 /** the requested memory size */
80 /** physical start_addr alignment in bytes for some HW requirements */
82 /** the requested memory domains */
84 /** allocation flags */
88 struct drm_amdgpu_gem_create_out
{
89 /** returned GEM object handle */
94 union drm_amdgpu_gem_create
{
95 struct drm_amdgpu_gem_create_in in
;
96 struct drm_amdgpu_gem_create_out out
;
99 /** Opcode to create new residency list. */
100 #define AMDGPU_BO_LIST_OP_CREATE 0
101 /** Opcode to destroy previously created residency list */
102 #define AMDGPU_BO_LIST_OP_DESTROY 1
103 /** Opcode to update resource information in the list */
104 #define AMDGPU_BO_LIST_OP_UPDATE 2
106 struct drm_amdgpu_bo_list_in
{
107 /** Type of operation */
109 /** Handle of list or 0 if we want to create one */
111 /** Number of BOs in list */
113 /** Size of each element describing BO */
115 /** Pointer to array describing BOs */
119 struct drm_amdgpu_bo_list_entry
{
122 /** New (if specified) BO priority to be used during migration */
126 struct drm_amdgpu_bo_list_out
{
127 /** Handle of resource list */
132 union drm_amdgpu_bo_list
{
133 struct drm_amdgpu_bo_list_in in
;
134 struct drm_amdgpu_bo_list_out out
;
137 /* context related */
138 #define AMDGPU_CTX_OP_ALLOC_CTX 1
139 #define AMDGPU_CTX_OP_FREE_CTX 2
140 #define AMDGPU_CTX_OP_QUERY_STATE 3
142 /* GPU reset status */
143 #define AMDGPU_CTX_NO_RESET 0
144 /* this the context caused it */
145 #define AMDGPU_CTX_GUILTY_RESET 1
146 /* some other context caused it */
147 #define AMDGPU_CTX_INNOCENT_RESET 2
149 #define AMDGPU_CTX_UNKNOWN_RESET 3
151 struct drm_amdgpu_ctx_in
{
152 /** AMDGPU_CTX_OP_* */
154 /** For future use, no flags defined so far */
160 union drm_amdgpu_ctx_out
{
167 /** For future use, no flags defined so far */
169 /** Number of resets caused by this context so far. */
171 /** Reset status since the last call of the ioctl. */
176 union drm_amdgpu_ctx
{
177 struct drm_amdgpu_ctx_in in
;
178 union drm_amdgpu_ctx_out out
;
182 * This is not a reliable API and you should expect it to fail for any
183 * number of reasons and have fallback path that do not use userptr to
184 * perform any operation.
186 #define AMDGPU_GEM_USERPTR_READONLY (1 << 0)
187 #define AMDGPU_GEM_USERPTR_ANONONLY (1 << 1)
188 #define AMDGPU_GEM_USERPTR_VALIDATE (1 << 2)
189 #define AMDGPU_GEM_USERPTR_REGISTER (1 << 3)
191 struct drm_amdgpu_gem_userptr
{
194 /* AMDGPU_GEM_USERPTR_* */
196 /* Resulting GEM handle */
200 /* same meaning as the GB_TILE_MODE and GL_MACRO_TILE_MODE fields */
201 #define AMDGPU_TILING_ARRAY_MODE_SHIFT 0
202 #define AMDGPU_TILING_ARRAY_MODE_MASK 0xf
203 #define AMDGPU_TILING_PIPE_CONFIG_SHIFT 4
204 #define AMDGPU_TILING_PIPE_CONFIG_MASK 0x1f
205 #define AMDGPU_TILING_TILE_SPLIT_SHIFT 9
206 #define AMDGPU_TILING_TILE_SPLIT_MASK 0x7
207 #define AMDGPU_TILING_MICRO_TILE_MODE_SHIFT 12
208 #define AMDGPU_TILING_MICRO_TILE_MODE_MASK 0x7
209 #define AMDGPU_TILING_BANK_WIDTH_SHIFT 15
210 #define AMDGPU_TILING_BANK_WIDTH_MASK 0x3
211 #define AMDGPU_TILING_BANK_HEIGHT_SHIFT 17
212 #define AMDGPU_TILING_BANK_HEIGHT_MASK 0x3
213 #define AMDGPU_TILING_MACRO_TILE_ASPECT_SHIFT 19
214 #define AMDGPU_TILING_MACRO_TILE_ASPECT_MASK 0x3
215 #define AMDGPU_TILING_NUM_BANKS_SHIFT 21
216 #define AMDGPU_TILING_NUM_BANKS_MASK 0x3
218 #define AMDGPU_TILING_SET(field, value) \
219 (((value) & AMDGPU_TILING_##field##_MASK) << AMDGPU_TILING_##field##_SHIFT)
220 #define AMDGPU_TILING_GET(value, field) \
221 (((value) >> AMDGPU_TILING_##field##_SHIFT) & AMDGPU_TILING_##field##_MASK)
223 #define AMDGPU_GEM_METADATA_OP_SET_METADATA 1
224 #define AMDGPU_GEM_METADATA_OP_GET_METADATA 2
226 /** The same structure is shared for input/output */
227 struct drm_amdgpu_gem_metadata
{
228 /** GEM Object handle */
230 /** Do we want get or set metadata */
233 /** For future use, no flags defined so far */
235 /** family specific tiling info */
237 __u32 data_size_bytes
;
242 struct drm_amdgpu_gem_mmap_in
{
243 /** the GEM object handle */
248 struct drm_amdgpu_gem_mmap_out
{
249 /** mmap offset from the vma offset manager */
253 union drm_amdgpu_gem_mmap
{
254 struct drm_amdgpu_gem_mmap_in in
;
255 struct drm_amdgpu_gem_mmap_out out
;
258 struct drm_amdgpu_gem_wait_idle_in
{
259 /** GEM object handle */
261 /** For future use, no flags defined so far */
263 /** Absolute timeout to wait */
267 struct drm_amdgpu_gem_wait_idle_out
{
268 /** BO status: 0 - BO is idle, 1 - BO is busy */
270 /** Returned current memory domain */
274 union drm_amdgpu_gem_wait_idle
{
275 struct drm_amdgpu_gem_wait_idle_in in
;
276 struct drm_amdgpu_gem_wait_idle_out out
;
279 struct drm_amdgpu_wait_cs_in
{
280 /** Command submission handle */
282 /** Absolute timeout to wait */
290 struct drm_amdgpu_wait_cs_out
{
291 /** CS status: 0 - CS completed, 1 - CS still busy */
295 union drm_amdgpu_wait_cs
{
296 struct drm_amdgpu_wait_cs_in in
;
297 struct drm_amdgpu_wait_cs_out out
;
300 #define AMDGPU_GEM_OP_GET_GEM_CREATE_INFO 0
301 #define AMDGPU_GEM_OP_SET_PLACEMENT 1
303 /* Sets or returns a value associated with a buffer. */
304 struct drm_amdgpu_gem_op
{
305 /** GEM object handle */
307 /** AMDGPU_GEM_OP_* */
309 /** Input or return value */
313 #define AMDGPU_VA_OP_MAP 1
314 #define AMDGPU_VA_OP_UNMAP 2
316 /* Delay the page table update till the next CS */
317 #define AMDGPU_VM_DELAY_UPDATE (1 << 0)
320 /* readable mapping */
321 #define AMDGPU_VM_PAGE_READABLE (1 << 1)
322 /* writable mapping */
323 #define AMDGPU_VM_PAGE_WRITEABLE (1 << 2)
324 /* executable mapping, new for VI */
325 #define AMDGPU_VM_PAGE_EXECUTABLE (1 << 3)
327 struct drm_amdgpu_gem_va
{
328 /** GEM object handle */
331 /** AMDGPU_VA_OP_* */
333 /** AMDGPU_VM_PAGE_* */
335 /** va address to assign . Must be correctly aligned.*/
337 /** Specify offset inside of BO to assign. Must be correctly aligned.*/
339 /** Specify mapping size. Must be correctly aligned. */
343 #define AMDGPU_HW_IP_GFX 0
344 #define AMDGPU_HW_IP_COMPUTE 1
345 #define AMDGPU_HW_IP_DMA 2
346 #define AMDGPU_HW_IP_UVD 3
347 #define AMDGPU_HW_IP_VCE 4
348 #define AMDGPU_HW_IP_NUM 5
350 #define AMDGPU_HW_IP_INSTANCE_MAX_COUNT 1
352 #define AMDGPU_CHUNK_ID_IB 0x01
353 #define AMDGPU_CHUNK_ID_FENCE 0x02
354 #define AMDGPU_CHUNK_ID_DEPENDENCIES 0x03
356 struct drm_amdgpu_cs_chunk
{
362 struct drm_amdgpu_cs_in
{
363 /** Rendering context id */
365 /** Handle of resource list associated with CS */
366 __u32 bo_list_handle
;
369 /** this points to __u64 * which point to cs chunks */
373 struct drm_amdgpu_cs_out
{
377 union drm_amdgpu_cs
{
378 struct drm_amdgpu_cs_in in
;
379 struct drm_amdgpu_cs_out out
;
382 /* Specify flags to be used for IB */
384 /* This IB should be submitted to CE */
385 #define AMDGPU_IB_FLAG_CE (1<<0)
388 #define AMDGPU_IB_FLAG_PREAMBLE (1<<1)
390 struct drm_amdgpu_cs_chunk_ib
{
392 /** AMDGPU_IB_FLAG_* */
394 /** Virtual address to begin IB execution */
396 /** Size of submission */
398 /** HW IP to submit to */
400 /** HW IP index of the same type to submit to */
402 /** Ring index to submit to */
406 struct drm_amdgpu_cs_chunk_dep
{
414 struct drm_amdgpu_cs_chunk_fence
{
419 struct drm_amdgpu_cs_chunk_data
{
421 struct drm_amdgpu_cs_chunk_ib ib_data
;
422 struct drm_amdgpu_cs_chunk_fence fence_data
;
427 * Query h/w info: Flag that this is integrated (a.h.a. fusion) GPU
430 #define AMDGPU_IDS_FLAGS_FUSION 0x1
432 /* indicate if acceleration can be working */
433 #define AMDGPU_INFO_ACCEL_WORKING 0x00
434 /* get the crtc_id from the mode object id? */
435 #define AMDGPU_INFO_CRTC_FROM_ID 0x01
436 /* query hw IP info */
437 #define AMDGPU_INFO_HW_IP_INFO 0x02
438 /* query hw IP instance count for the specified type */
439 #define AMDGPU_INFO_HW_IP_COUNT 0x03
440 /* timestamp for GL_ARB_timer_query */
441 #define AMDGPU_INFO_TIMESTAMP 0x05
442 /* Query the firmware version */
443 #define AMDGPU_INFO_FW_VERSION 0x0e
444 /* Subquery id: Query VCE firmware version */
445 #define AMDGPU_INFO_FW_VCE 0x1
446 /* Subquery id: Query UVD firmware version */
447 #define AMDGPU_INFO_FW_UVD 0x2
448 /* Subquery id: Query GMC firmware version */
449 #define AMDGPU_INFO_FW_GMC 0x03
450 /* Subquery id: Query GFX ME firmware version */
451 #define AMDGPU_INFO_FW_GFX_ME 0x04
452 /* Subquery id: Query GFX PFP firmware version */
453 #define AMDGPU_INFO_FW_GFX_PFP 0x05
454 /* Subquery id: Query GFX CE firmware version */
455 #define AMDGPU_INFO_FW_GFX_CE 0x06
456 /* Subquery id: Query GFX RLC firmware version */
457 #define AMDGPU_INFO_FW_GFX_RLC 0x07
458 /* Subquery id: Query GFX MEC firmware version */
459 #define AMDGPU_INFO_FW_GFX_MEC 0x08
460 /* Subquery id: Query SMC firmware version */
461 #define AMDGPU_INFO_FW_SMC 0x0a
462 /* Subquery id: Query SDMA firmware version */
463 #define AMDGPU_INFO_FW_SDMA 0x0b
464 /* number of bytes moved for TTM migration */
465 #define AMDGPU_INFO_NUM_BYTES_MOVED 0x0f
466 /* the used VRAM size */
467 #define AMDGPU_INFO_VRAM_USAGE 0x10
468 /* the used GTT size */
469 #define AMDGPU_INFO_GTT_USAGE 0x11
470 /* Information about GDS, etc. resource configuration */
471 #define AMDGPU_INFO_GDS_CONFIG 0x13
472 /* Query information about VRAM and GTT domains */
473 #define AMDGPU_INFO_VRAM_GTT 0x14
474 /* Query information about register in MMR address space*/
475 #define AMDGPU_INFO_READ_MMR_REG 0x15
476 /* Query information about device: rev id, family, etc. */
477 #define AMDGPU_INFO_DEV_INFO 0x16
478 /* visible vram usage */
479 #define AMDGPU_INFO_VIS_VRAM_USAGE 0x17
481 #define AMDGPU_INFO_MMR_SE_INDEX_SHIFT 0
482 #define AMDGPU_INFO_MMR_SE_INDEX_MASK 0xff
483 #define AMDGPU_INFO_MMR_SH_INDEX_SHIFT 8
484 #define AMDGPU_INFO_MMR_SH_INDEX_MASK 0xff
486 /* Input structure for the INFO ioctl */
487 struct drm_amdgpu_info
{
488 /* Where the return value will be stored */
489 __u64 return_pointer
;
490 /* The size of the return value. Just like "size" in "snprintf",
491 * it limits how many bytes the kernel can write. */
493 /* The query request id. */
503 /** AMDGPU_HW_IP_* */
506 * Index of the IP if there are more IPs of the same
507 * type. Ignored by AMDGPU_INFO_HW_IP_COUNT.
514 /** number of registers to read */
517 /** For future use, no flags defined so far */
522 /** AMDGPU_INFO_FW_* */
525 * Index of the IP if there are more IPs of
530 * Index of the engine. Whether this is used depends
531 * on the firmware type. (e.g. MEC, SDMA)
539 struct drm_amdgpu_info_gds
{
540 /** GDS GFX partition size */
541 __u32 gds_gfx_partition_size
;
542 /** GDS compute partition size */
543 __u32 compute_partition_size
;
544 /** total GDS memory size */
545 __u32 gds_total_size
;
546 /** GWS size per GFX partition */
547 __u32 gws_per_gfx_partition
;
548 /** GSW size per compute partition */
549 __u32 gws_per_compute_partition
;
550 /** OA size per GFX partition */
551 __u32 oa_per_gfx_partition
;
552 /** OA size per compute partition */
553 __u32 oa_per_compute_partition
;
557 struct drm_amdgpu_info_vram_gtt
{
559 __u64 vram_cpu_accessible_size
;
563 struct drm_amdgpu_info_firmware
{
568 #define AMDGPU_VRAM_TYPE_UNKNOWN 0
569 #define AMDGPU_VRAM_TYPE_GDDR1 1
570 #define AMDGPU_VRAM_TYPE_DDR2 2
571 #define AMDGPU_VRAM_TYPE_GDDR3 3
572 #define AMDGPU_VRAM_TYPE_GDDR4 4
573 #define AMDGPU_VRAM_TYPE_GDDR5 5
574 #define AMDGPU_VRAM_TYPE_HBM 6
575 #define AMDGPU_VRAM_TYPE_DDR3 7
577 struct drm_amdgpu_info_device
{
580 /** Internal chip revision: A0, A1, etc.) */
583 /** Revision id in PCI Config space */
586 __u32 num_shader_engines
;
587 __u32 num_shader_arrays_per_engine
;
589 __u32 gpu_counter_freq
;
590 __u64 max_engine_clock
;
591 __u64 max_memory_clock
;
593 __u32 cu_active_number
;
595 __u32 cu_bitmap
[4][4];
596 /** Render backend pipe mask. One render backend is CB+DB. */
597 __u32 enabled_rb_pipes_mask
;
599 __u32 num_hw_gfx_contexts
;
602 /** Starting virtual address for UMDs. */
603 __u64 virtual_address_offset
;
604 /** The maximum virtual address */
605 __u64 virtual_address_max
;
606 /** Required alignment of virtual addresses. */
607 __u32 virtual_address_alignment
;
608 /** Page table entry - fragment size */
609 __u32 pte_fragment_size
;
610 __u32 gart_page_size
;
611 /** constant engine ram size*/
613 /** video memory type info*/
615 /** video memory bit width*/
616 __u32 vram_bit_width
;
617 /* vce harvesting instance */
618 __u32 vce_harvest_config
;
621 struct drm_amdgpu_info_hw_ip
{
622 /** Version of h/w IP */
623 __u32 hw_ip_version_major
;
624 __u32 hw_ip_version_minor
;
626 __u64 capabilities_flags
;
627 /** command buffer address start alignment*/
628 __u32 ib_start_alignment
;
629 /** command buffer size alignment*/
630 __u32 ib_size_alignment
;
631 /** Bitmask of available rings. Bit 0 means ring 0, etc. */
632 __u32 available_rings
;
637 * Supported GPU families
639 #define AMDGPU_FAMILY_UNKNOWN 0
640 #define AMDGPU_FAMILY_CI 120 /* Bonaire, Hawaii */
641 #define AMDGPU_FAMILY_KV 125 /* Kaveri, Kabini, Mullins */
642 #define AMDGPU_FAMILY_VI 130 /* Iceland, Tonga */
643 #define AMDGPU_FAMILY_CZ 135 /* Carrizo, Stoney */