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 #if defined(__cplusplus)
41 #define DRM_AMDGPU_GEM_CREATE 0x00
42 #define DRM_AMDGPU_GEM_MMAP 0x01
43 #define DRM_AMDGPU_CTX 0x02
44 #define DRM_AMDGPU_BO_LIST 0x03
45 #define DRM_AMDGPU_CS 0x04
46 #define DRM_AMDGPU_INFO 0x05
47 #define DRM_AMDGPU_GEM_METADATA 0x06
48 #define DRM_AMDGPU_GEM_WAIT_IDLE 0x07
49 #define DRM_AMDGPU_GEM_VA 0x08
50 #define DRM_AMDGPU_WAIT_CS 0x09
51 #define DRM_AMDGPU_GEM_OP 0x10
52 #define DRM_AMDGPU_GEM_USERPTR 0x11
54 #define DRM_IOCTL_AMDGPU_GEM_CREATE DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_CREATE, union drm_amdgpu_gem_create)
55 #define DRM_IOCTL_AMDGPU_GEM_MMAP DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_MMAP, union drm_amdgpu_gem_mmap)
56 #define DRM_IOCTL_AMDGPU_CTX DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_CTX, union drm_amdgpu_ctx)
57 #define DRM_IOCTL_AMDGPU_BO_LIST DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_BO_LIST, union drm_amdgpu_bo_list)
58 #define DRM_IOCTL_AMDGPU_CS DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_CS, union drm_amdgpu_cs)
59 #define DRM_IOCTL_AMDGPU_INFO DRM_IOW(DRM_COMMAND_BASE + DRM_AMDGPU_INFO, struct drm_amdgpu_info)
60 #define DRM_IOCTL_AMDGPU_GEM_METADATA DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_METADATA, struct drm_amdgpu_gem_metadata)
61 #define DRM_IOCTL_AMDGPU_GEM_WAIT_IDLE DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_WAIT_IDLE, union drm_amdgpu_gem_wait_idle)
62 #define DRM_IOCTL_AMDGPU_GEM_VA DRM_IOW(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_VA, struct drm_amdgpu_gem_va)
63 #define DRM_IOCTL_AMDGPU_WAIT_CS DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_WAIT_CS, union drm_amdgpu_wait_cs)
64 #define DRM_IOCTL_AMDGPU_GEM_OP DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_OP, struct drm_amdgpu_gem_op)
65 #define DRM_IOCTL_AMDGPU_GEM_USERPTR DRM_IOWR(DRM_COMMAND_BASE + DRM_AMDGPU_GEM_USERPTR, struct drm_amdgpu_gem_userptr)
67 #define AMDGPU_GEM_DOMAIN_CPU 0x1
68 #define AMDGPU_GEM_DOMAIN_GTT 0x2
69 #define AMDGPU_GEM_DOMAIN_VRAM 0x4
70 #define AMDGPU_GEM_DOMAIN_GDS 0x8
71 #define AMDGPU_GEM_DOMAIN_GWS 0x10
72 #define AMDGPU_GEM_DOMAIN_OA 0x20
74 /* Flag that CPU access will be required for the case of VRAM domain */
75 #define AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED (1 << 0)
76 /* Flag that CPU access will not work, this VRAM domain is invisible */
77 #define AMDGPU_GEM_CREATE_NO_CPU_ACCESS (1 << 1)
78 /* Flag that USWC attributes should be used for GTT */
79 #define AMDGPU_GEM_CREATE_CPU_GTT_USWC (1 << 2)
81 struct drm_amdgpu_gem_create_in {
82 /** the requested memory size */
84 /** physical start_addr alignment in bytes for some HW requirements */
86 /** the requested memory domains */
88 /** allocation flags */
92 struct drm_amdgpu_gem_create_out {
93 /** returned GEM object handle */
98 union drm_amdgpu_gem_create {
99 struct drm_amdgpu_gem_create_in in;
100 struct drm_amdgpu_gem_create_out out;
103 /** Opcode to create new residency list. */
104 #define AMDGPU_BO_LIST_OP_CREATE 0
105 /** Opcode to destroy previously created residency list */
106 #define AMDGPU_BO_LIST_OP_DESTROY 1
107 /** Opcode to update resource information in the list */
108 #define AMDGPU_BO_LIST_OP_UPDATE 2
110 struct drm_amdgpu_bo_list_in {
111 /** Type of operation */
113 /** Handle of list or 0 if we want to create one */
115 /** Number of BOs in list */
117 /** Size of each element describing BO */
119 /** Pointer to array describing BOs */
123 struct drm_amdgpu_bo_list_entry {
126 /** New (if specified) BO priority to be used during migration */
130 struct drm_amdgpu_bo_list_out {
131 /** Handle of resource list */
136 union drm_amdgpu_bo_list {
137 struct drm_amdgpu_bo_list_in in;
138 struct drm_amdgpu_bo_list_out out;
141 /* context related */
142 #define AMDGPU_CTX_OP_ALLOC_CTX 1
143 #define AMDGPU_CTX_OP_FREE_CTX 2
144 #define AMDGPU_CTX_OP_QUERY_STATE 3
146 /* GPU reset status */
147 #define AMDGPU_CTX_NO_RESET 0
148 /* this the context caused it */
149 #define AMDGPU_CTX_GUILTY_RESET 1
150 /* some other context caused it */
151 #define AMDGPU_CTX_INNOCENT_RESET 2
153 #define AMDGPU_CTX_UNKNOWN_RESET 3
155 struct drm_amdgpu_ctx_in {
156 /** AMDGPU_CTX_OP_* */
158 /** For future use, no flags defined so far */
164 union drm_amdgpu_ctx_out {
171 /** For future use, no flags defined so far */
173 /** Number of resets caused by this context so far. */
175 /** Reset status since the last call of the ioctl. */
180 union drm_amdgpu_ctx {
181 struct drm_amdgpu_ctx_in in;
182 union drm_amdgpu_ctx_out out;
186 * This is not a reliable API and you should expect it to fail for any
187 * number of reasons and have fallback path that do not use userptr to
188 * perform any operation.
190 #define AMDGPU_GEM_USERPTR_READONLY (1 << 0)
191 #define AMDGPU_GEM_USERPTR_ANONONLY (1 << 1)
192 #define AMDGPU_GEM_USERPTR_VALIDATE (1 << 2)
193 #define AMDGPU_GEM_USERPTR_REGISTER (1 << 3)
195 struct drm_amdgpu_gem_userptr {
198 /* AMDGPU_GEM_USERPTR_* */
200 /* Resulting GEM handle */
204 /* same meaning as the GB_TILE_MODE and GL_MACRO_TILE_MODE fields */
205 #define AMDGPU_TILING_ARRAY_MODE_SHIFT 0
206 #define AMDGPU_TILING_ARRAY_MODE_MASK 0xf
207 #define AMDGPU_TILING_PIPE_CONFIG_SHIFT 4
208 #define AMDGPU_TILING_PIPE_CONFIG_MASK 0x1f
209 #define AMDGPU_TILING_TILE_SPLIT_SHIFT 9
210 #define AMDGPU_TILING_TILE_SPLIT_MASK 0x7
211 #define AMDGPU_TILING_MICRO_TILE_MODE_SHIFT 12
212 #define AMDGPU_TILING_MICRO_TILE_MODE_MASK 0x7
213 #define AMDGPU_TILING_BANK_WIDTH_SHIFT 15
214 #define AMDGPU_TILING_BANK_WIDTH_MASK 0x3
215 #define AMDGPU_TILING_BANK_HEIGHT_SHIFT 17
216 #define AMDGPU_TILING_BANK_HEIGHT_MASK 0x3
217 #define AMDGPU_TILING_MACRO_TILE_ASPECT_SHIFT 19
218 #define AMDGPU_TILING_MACRO_TILE_ASPECT_MASK 0x3
219 #define AMDGPU_TILING_NUM_BANKS_SHIFT 21
220 #define AMDGPU_TILING_NUM_BANKS_MASK 0x3
222 #define AMDGPU_TILING_SET(field, value) \
223 (((value) & AMDGPU_TILING_##field##_MASK) << AMDGPU_TILING_##field##_SHIFT)
224 #define AMDGPU_TILING_GET(value, field) \
225 (((value) >> AMDGPU_TILING_##field##_SHIFT) & AMDGPU_TILING_##field##_MASK)
227 #define AMDGPU_GEM_METADATA_OP_SET_METADATA 1
228 #define AMDGPU_GEM_METADATA_OP_GET_METADATA 2
230 /** The same structure is shared for input/output */
231 struct drm_amdgpu_gem_metadata {
232 /** GEM Object handle */
234 /** Do we want get or set metadata */
237 /** For future use, no flags defined so far */
239 /** family specific tiling info */
241 __u32 data_size_bytes;
246 struct drm_amdgpu_gem_mmap_in {
247 /** the GEM object handle */
252 struct drm_amdgpu_gem_mmap_out {
253 /** mmap offset from the vma offset manager */
257 union drm_amdgpu_gem_mmap {
258 struct drm_amdgpu_gem_mmap_in in;
259 struct drm_amdgpu_gem_mmap_out out;
262 struct drm_amdgpu_gem_wait_idle_in {
263 /** GEM object handle */
265 /** For future use, no flags defined so far */
267 /** Absolute timeout to wait */
271 struct drm_amdgpu_gem_wait_idle_out {
272 /** BO status: 0 - BO is idle, 1 - BO is busy */
274 /** Returned current memory domain */
278 union drm_amdgpu_gem_wait_idle {
279 struct drm_amdgpu_gem_wait_idle_in in;
280 struct drm_amdgpu_gem_wait_idle_out out;
283 struct drm_amdgpu_wait_cs_in {
284 /** Command submission handle */
286 /** Absolute timeout to wait */
294 struct drm_amdgpu_wait_cs_out {
295 /** CS status: 0 - CS completed, 1 - CS still busy */
299 union drm_amdgpu_wait_cs {
300 struct drm_amdgpu_wait_cs_in in;
301 struct drm_amdgpu_wait_cs_out out;
304 #define AMDGPU_GEM_OP_GET_GEM_CREATE_INFO 0
305 #define AMDGPU_GEM_OP_SET_PLACEMENT 1
307 /* Sets or returns a value associated with a buffer. */
308 struct drm_amdgpu_gem_op {
309 /** GEM object handle */
311 /** AMDGPU_GEM_OP_* */
313 /** Input or return value */
317 #define AMDGPU_VA_OP_MAP 1
318 #define AMDGPU_VA_OP_UNMAP 2
320 /* Delay the page table update till the next CS */
321 #define AMDGPU_VM_DELAY_UPDATE (1 << 0)
324 /* readable mapping */
325 #define AMDGPU_VM_PAGE_READABLE (1 << 1)
326 /* writable mapping */
327 #define AMDGPU_VM_PAGE_WRITEABLE (1 << 2)
328 /* executable mapping, new for VI */
329 #define AMDGPU_VM_PAGE_EXECUTABLE (1 << 3)
331 struct drm_amdgpu_gem_va {
332 /** GEM object handle */
335 /** AMDGPU_VA_OP_* */
337 /** AMDGPU_VM_PAGE_* */
339 /** va address to assign . Must be correctly aligned.*/
341 /** Specify offset inside of BO to assign. Must be correctly aligned.*/
343 /** Specify mapping size. Must be correctly aligned. */
347 #define AMDGPU_HW_IP_GFX 0
348 #define AMDGPU_HW_IP_COMPUTE 1
349 #define AMDGPU_HW_IP_DMA 2
350 #define AMDGPU_HW_IP_UVD 3
351 #define AMDGPU_HW_IP_VCE 4
352 #define AMDGPU_HW_IP_NUM 5
354 #define AMDGPU_HW_IP_INSTANCE_MAX_COUNT 1
356 #define AMDGPU_CHUNK_ID_IB 0x01
357 #define AMDGPU_CHUNK_ID_FENCE 0x02
358 #define AMDGPU_CHUNK_ID_DEPENDENCIES 0x03
360 struct drm_amdgpu_cs_chunk {
366 struct drm_amdgpu_cs_in {
367 /** Rendering context id */
369 /** Handle of resource list associated with CS */
370 __u32 bo_list_handle;
373 /** this points to __u64 * which point to cs chunks */
377 struct drm_amdgpu_cs_out {
381 union drm_amdgpu_cs {
382 struct drm_amdgpu_cs_in in;
383 struct drm_amdgpu_cs_out out;
386 /* Specify flags to be used for IB */
388 /* This IB should be submitted to CE */
389 #define AMDGPU_IB_FLAG_CE (1<<0)
392 #define AMDGPU_IB_FLAG_PREAMBLE (1<<1)
394 struct drm_amdgpu_cs_chunk_ib {
396 /** AMDGPU_IB_FLAG_* */
398 /** Virtual address to begin IB execution */
400 /** Size of submission */
402 /** HW IP to submit to */
404 /** HW IP index of the same type to submit to */
406 /** Ring index to submit to */
410 struct drm_amdgpu_cs_chunk_dep {
418 struct drm_amdgpu_cs_chunk_fence {
423 struct drm_amdgpu_cs_chunk_data {
425 struct drm_amdgpu_cs_chunk_ib ib_data;
426 struct drm_amdgpu_cs_chunk_fence fence_data;
431 * Query h/w info: Flag that this is integrated (a.h.a. fusion) GPU
434 #define AMDGPU_IDS_FLAGS_FUSION 0x1
436 /* indicate if acceleration can be working */
437 #define AMDGPU_INFO_ACCEL_WORKING 0x00
438 /* get the crtc_id from the mode object id? */
439 #define AMDGPU_INFO_CRTC_FROM_ID 0x01
440 /* query hw IP info */
441 #define AMDGPU_INFO_HW_IP_INFO 0x02
442 /* query hw IP instance count for the specified type */
443 #define AMDGPU_INFO_HW_IP_COUNT 0x03
444 /* timestamp for GL_ARB_timer_query */
445 #define AMDGPU_INFO_TIMESTAMP 0x05
446 /* Query the firmware version */
447 #define AMDGPU_INFO_FW_VERSION 0x0e
448 /* Subquery id: Query VCE firmware version */
449 #define AMDGPU_INFO_FW_VCE 0x1
450 /* Subquery id: Query UVD firmware version */
451 #define AMDGPU_INFO_FW_UVD 0x2
452 /* Subquery id: Query GMC firmware version */
453 #define AMDGPU_INFO_FW_GMC 0x03
454 /* Subquery id: Query GFX ME firmware version */
455 #define AMDGPU_INFO_FW_GFX_ME 0x04
456 /* Subquery id: Query GFX PFP firmware version */
457 #define AMDGPU_INFO_FW_GFX_PFP 0x05
458 /* Subquery id: Query GFX CE firmware version */
459 #define AMDGPU_INFO_FW_GFX_CE 0x06
460 /* Subquery id: Query GFX RLC firmware version */
461 #define AMDGPU_INFO_FW_GFX_RLC 0x07
462 /* Subquery id: Query GFX MEC firmware version */
463 #define AMDGPU_INFO_FW_GFX_MEC 0x08
464 /* Subquery id: Query SMC firmware version */
465 #define AMDGPU_INFO_FW_SMC 0x0a
466 /* Subquery id: Query SDMA firmware version */
467 #define AMDGPU_INFO_FW_SDMA 0x0b
468 /* number of bytes moved for TTM migration */
469 #define AMDGPU_INFO_NUM_BYTES_MOVED 0x0f
470 /* the used VRAM size */
471 #define AMDGPU_INFO_VRAM_USAGE 0x10
472 /* the used GTT size */
473 #define AMDGPU_INFO_GTT_USAGE 0x11
474 /* Information about GDS, etc. resource configuration */
475 #define AMDGPU_INFO_GDS_CONFIG 0x13
476 /* Query information about VRAM and GTT domains */
477 #define AMDGPU_INFO_VRAM_GTT 0x14
478 /* Query information about register in MMR address space*/
479 #define AMDGPU_INFO_READ_MMR_REG 0x15
480 /* Query information about device: rev id, family, etc. */
481 #define AMDGPU_INFO_DEV_INFO 0x16
482 /* visible vram usage */
483 #define AMDGPU_INFO_VIS_VRAM_USAGE 0x17
485 #define AMDGPU_INFO_MMR_SE_INDEX_SHIFT 0
486 #define AMDGPU_INFO_MMR_SE_INDEX_MASK 0xff
487 #define AMDGPU_INFO_MMR_SH_INDEX_SHIFT 8
488 #define AMDGPU_INFO_MMR_SH_INDEX_MASK 0xff
490 struct drm_amdgpu_query_fw {
491 /** AMDGPU_INFO_FW_* */
494 * Index of the IP if there are more IPs of
499 * Index of the engine. Whether this is used depends
500 * on the firmware type. (e.g. MEC, SDMA)
506 /* Input structure for the INFO ioctl */
507 struct drm_amdgpu_info {
508 /* Where the return value will be stored */
509 __u64 return_pointer;
510 /* The size of the return value. Just like "size" in "snprintf",
511 * it limits how many bytes the kernel can write. */
513 /* The query request id. */
523 /** AMDGPU_HW_IP_* */
526 * Index of the IP if there are more IPs of the same
527 * type. Ignored by AMDGPU_INFO_HW_IP_COUNT.
534 /** number of registers to read */
537 /** For future use, no flags defined so far */
541 struct drm_amdgpu_query_fw query_fw;
545 struct drm_amdgpu_info_gds {
546 /** GDS GFX partition size */
547 __u32 gds_gfx_partition_size;
548 /** GDS compute partition size */
549 __u32 compute_partition_size;
550 /** total GDS memory size */
551 __u32 gds_total_size;
552 /** GWS size per GFX partition */
553 __u32 gws_per_gfx_partition;
554 /** GSW size per compute partition */
555 __u32 gws_per_compute_partition;
556 /** OA size per GFX partition */
557 __u32 oa_per_gfx_partition;
558 /** OA size per compute partition */
559 __u32 oa_per_compute_partition;
563 struct drm_amdgpu_info_vram_gtt {
565 __u64 vram_cpu_accessible_size;
569 struct drm_amdgpu_info_firmware {
574 #define AMDGPU_VRAM_TYPE_UNKNOWN 0
575 #define AMDGPU_VRAM_TYPE_GDDR1 1
576 #define AMDGPU_VRAM_TYPE_DDR2 2
577 #define AMDGPU_VRAM_TYPE_GDDR3 3
578 #define AMDGPU_VRAM_TYPE_GDDR4 4
579 #define AMDGPU_VRAM_TYPE_GDDR5 5
580 #define AMDGPU_VRAM_TYPE_HBM 6
581 #define AMDGPU_VRAM_TYPE_DDR3 7
583 struct drm_amdgpu_info_device {
586 /** Internal chip revision: A0, A1, etc.) */
589 /** Revision id in PCI Config space */
592 __u32 num_shader_engines;
593 __u32 num_shader_arrays_per_engine;
595 __u32 gpu_counter_freq;
596 __u64 max_engine_clock;
597 __u64 max_memory_clock;
599 __u32 cu_active_number;
601 __u32 cu_bitmap[4][4];
602 /** Render backend pipe mask. One render backend is CB+DB. */
603 __u32 enabled_rb_pipes_mask;
605 __u32 num_hw_gfx_contexts;
608 /** Starting virtual address for UMDs. */
609 __u64 virtual_address_offset;
610 /** The maximum virtual address */
611 __u64 virtual_address_max;
612 /** Required alignment of virtual addresses. */
613 __u32 virtual_address_alignment;
614 /** Page table entry - fragment size */
615 __u32 pte_fragment_size;
616 __u32 gart_page_size;
617 /** constant engine ram size*/
619 /** video memory type info*/
621 /** video memory bit width*/
622 __u32 vram_bit_width;
623 /* vce harvesting instance */
624 __u32 vce_harvest_config;
627 struct drm_amdgpu_info_hw_ip {
628 /** Version of h/w IP */
629 __u32 hw_ip_version_major;
630 __u32 hw_ip_version_minor;
632 __u64 capabilities_flags;
633 /** command buffer address start alignment*/
634 __u32 ib_start_alignment;
635 /** command buffer size alignment*/
636 __u32 ib_size_alignment;
637 /** Bitmask of available rings. Bit 0 means ring 0, etc. */
638 __u32 available_rings;
643 * Supported GPU families
645 #define AMDGPU_FAMILY_UNKNOWN 0
646 #define AMDGPU_FAMILY_CI 120 /* Bonaire, Hawaii */
647 #define AMDGPU_FAMILY_KV 125 /* Kaveri, Kabini, Mullins */
648 #define AMDGPU_FAMILY_VI 130 /* Iceland, Tonga */
649 #define AMDGPU_FAMILY_CZ 135 /* Carrizo, Stoney */
651 #if defined(__cplusplus)