2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
3 * Copyright 2010 Marek Olšák <maraeo@gmail.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * on the rights to use, copy, modify, merge, publish, distribute, sub
9 * license, and/or sell copies of the Software, and to permit persons to whom
10 * the Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
22 * USE OR OTHER DEALINGS IN THE SOFTWARE. */
24 #ifndef RADEON_WINSYS_H
25 #define RADEON_WINSYS_H
27 /* The public winsys interface header for the radeon driver. */
29 #include "pipebuffer/pb_buffer.h"
31 #define RADEON_FLUSH_ASYNC (1 << 0)
32 #define RADEON_FLUSH_KEEP_TILING_FLAGS (1 << 1)
33 #define RADEON_FLUSH_END_OF_FRAME (1 << 2)
36 enum radeon_bo_layout
{
37 RADEON_LAYOUT_LINEAR
= 0,
39 RADEON_LAYOUT_SQUARETILED
,
44 enum radeon_bo_domain
{ /* bitfield */
45 RADEON_DOMAIN_GTT
= 2,
46 RADEON_DOMAIN_VRAM
= 4,
47 RADEON_DOMAIN_VRAM_GTT
= RADEON_DOMAIN_VRAM
| RADEON_DOMAIN_GTT
50 enum radeon_bo_flag
{ /* bitfield */
51 RADEON_FLAG_GTT_WC
= (1 << 0),
52 RADEON_FLAG_CPU_ACCESS
= (1 << 1),
53 RADEON_FLAG_NO_CPU_ACCESS
= (1 << 2),
56 enum radeon_bo_usage
{ /* bitfield */
57 RADEON_USAGE_READ
= 2,
58 RADEON_USAGE_WRITE
= 4,
59 RADEON_USAGE_READWRITE
= RADEON_USAGE_READ
| RADEON_USAGE_WRITE
64 CHIP_R300
, /* R3xx-based cores. */
72 CHIP_R420
, /* R4xx-based cores. */
81 CHIP_RV515
, /* R5xx-based cores. */
153 enum radeon_value_id
{
154 RADEON_REQUESTED_VRAM_MEMORY
,
155 RADEON_REQUESTED_GTT_MEMORY
,
156 RADEON_BUFFER_WAIT_TIME_NS
,
158 RADEON_NUM_CS_FLUSHES
,
159 RADEON_NUM_BYTES_MOVED
,
162 RADEON_GPU_TEMPERATURE
, /* DRM 2.42.0 */
165 RADEON_GPU_RESET_COUNTER
, /* DRM 2.43.0 */
168 /* Each group of four has the same priority. */
169 enum radeon_bo_priority
{
170 RADEON_PRIO_FENCE
= 0,
172 RADEON_PRIO_SO_FILLED_SIZE
,
175 RADEON_PRIO_IB1
= 4, /* main IB submitted to the kernel */
176 RADEON_PRIO_IB2
, /* IB executed with INDIRECT_BUFFER */
177 RADEON_PRIO_DRAW_INDIRECT
,
178 RADEON_PRIO_INDEX_BUFFER
,
180 RADEON_PRIO_CP_DMA
= 8,
182 RADEON_PRIO_VCE
= 12,
184 RADEON_PRIO_SDMA_BUFFER
,
185 RADEON_PRIO_SDMA_TEXTURE
,
187 RADEON_PRIO_USER_SHADER
= 16,
188 RADEON_PRIO_INTERNAL_SHADER
, /* fetch shader, etc. */
192 RADEON_PRIO_CONST_BUFFER
= 24,
193 RADEON_PRIO_DESCRIPTORS
,
194 RADEON_PRIO_BORDER_COLORS
,
196 RADEON_PRIO_SAMPLER_BUFFER
= 28,
197 RADEON_PRIO_VERTEX_BUFFER
,
199 RADEON_PRIO_SHADER_RW_BUFFER
= 32,
200 RADEON_PRIO_RINGS_STREAMOUT
,
201 RADEON_PRIO_SCRATCH_BUFFER
,
202 RADEON_PRIO_COMPUTE_GLOBAL
,
204 RADEON_PRIO_SAMPLER_TEXTURE
= 36,
205 RADEON_PRIO_SHADER_RW_IMAGE
,
207 RADEON_PRIO_SAMPLER_TEXTURE_MSAA
= 40,
209 RADEON_PRIO_COLOR_BUFFER
= 44,
211 RADEON_PRIO_DEPTH_BUFFER
= 48,
213 RADEON_PRIO_COLOR_BUFFER_MSAA
= 52,
215 RADEON_PRIO_DEPTH_BUFFER_MSAA
= 56,
217 RADEON_PRIO_CMASK
= 60,
220 /* 63 is the maximum value */
223 struct winsys_handle
;
224 struct radeon_winsys_ctx
;
226 struct radeon_winsys_cs
{
227 unsigned cdw
; /* Number of used dwords. */
228 unsigned max_dw
; /* Maximum number of dwords. */
229 uint32_t *buf
; /* The command buffer. */
230 enum ring_type ring_type
;
234 /* PCI info: domain:bus:dev:func */
242 enum radeon_family family
;
243 enum chip_class chip_class
;
246 boolean has_virtual_memory
;
247 bool gfx_ib_pad_with_type2
;
250 uint32_t vce_fw_version
;
251 uint32_t vce_harvest_config
;
252 uint32_t clock_crystal_freq
;
255 uint32_t drm_major
; /* version */
257 uint32_t drm_patchlevel
;
261 uint32_t r600_max_quad_pipes
; /* wave size / 16 */
262 uint32_t max_shader_clock
;
263 uint32_t num_good_compute_units
;
264 uint32_t max_se
; /* shader engines */
265 uint32_t max_sh_per_se
; /* shader arrays per shader engine */
267 /* Render backends (color + depth blocks). */
268 uint32_t r300_num_gb_pipes
;
269 uint32_t r300_num_z_pipes
;
270 uint32_t r600_gb_backend_map
; /* R600 harvest config */
271 boolean r600_gb_backend_map_valid
;
272 uint32_t r600_num_banks
;
273 uint32_t num_render_backends
;
274 uint32_t num_tile_pipes
; /* pipe count from PIPE_CONFIG */
275 uint32_t pipe_interleave_bytes
;
276 uint32_t enabled_rb_mask
; /* GCN harvest config */
279 boolean si_tile_mode_array_valid
;
280 uint32_t si_tile_mode_array
[32];
281 boolean cik_macrotile_mode_array_valid
;
282 uint32_t cik_macrotile_mode_array
[16];
285 /* Tiling info for display code, DRI sharing, and other data. */
286 struct radeon_bo_metadata
{
287 /* Tiling flags describing the texture layout for display code
290 enum radeon_bo_layout microtile
;
291 enum radeon_bo_layout macrotile
;
292 unsigned pipe_config
;
296 unsigned stencil_tile_split
;
302 /* Additional metadata associated with the buffer, in bytes.
303 * The maximum size is 64 * 4. This is opaque for the winsys & kernel.
304 * Supported by amdgpu only.
306 uint32_t size_metadata
;
307 uint32_t metadata
[64];
310 enum radeon_feature_id
{
311 RADEON_FID_R300_HYPERZ_ACCESS
, /* ZMask + HiZ */
312 RADEON_FID_R300_CMASK_ACCESS
,
315 #define RADEON_SURF_MAX_LEVEL 32
317 #define RADEON_SURF_TYPE_MASK 0xFF
318 #define RADEON_SURF_TYPE_SHIFT 0
319 #define RADEON_SURF_TYPE_1D 0
320 #define RADEON_SURF_TYPE_2D 1
321 #define RADEON_SURF_TYPE_3D 2
322 #define RADEON_SURF_TYPE_CUBEMAP 3
323 #define RADEON_SURF_TYPE_1D_ARRAY 4
324 #define RADEON_SURF_TYPE_2D_ARRAY 5
325 #define RADEON_SURF_MODE_MASK 0xFF
326 #define RADEON_SURF_MODE_SHIFT 8
327 #define RADEON_SURF_MODE_LINEAR 0
328 #define RADEON_SURF_MODE_LINEAR_ALIGNED 1
329 #define RADEON_SURF_MODE_1D 2
330 #define RADEON_SURF_MODE_2D 3
331 #define RADEON_SURF_SCANOUT (1 << 16)
332 #define RADEON_SURF_ZBUFFER (1 << 17)
333 #define RADEON_SURF_SBUFFER (1 << 18)
334 #define RADEON_SURF_Z_OR_SBUFFER (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
335 #define RADEON_SURF_HAS_SBUFFER_MIPTREE (1 << 19)
336 #define RADEON_SURF_HAS_TILE_MODE_INDEX (1 << 20)
337 #define RADEON_SURF_FMASK (1 << 21)
339 #define RADEON_SURF_GET(v, field) (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
340 #define RADEON_SURF_SET(v, field) (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
341 #define RADEON_SURF_CLR(v, field) ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
343 struct radeon_surf_level
{
352 uint32_t pitch_bytes
;
358 /* These are inputs to the calculator. */
371 /* These are return values. Some of them can be set by the caller, but
372 * they will be treated as hints (e.g. bankw, bankh) and might be
373 * changed by the calculator.
376 uint64_t bo_alignment
;
377 /* This applies to EG and later. */
382 uint32_t stencil_tile_split
;
383 uint64_t stencil_offset
;
384 struct radeon_surf_level level
[RADEON_SURF_MAX_LEVEL
];
385 struct radeon_surf_level stencil_level
[RADEON_SURF_MAX_LEVEL
];
386 uint32_t tiling_index
[RADEON_SURF_MAX_LEVEL
];
387 uint32_t stencil_tiling_index
[RADEON_SURF_MAX_LEVEL
];
388 uint32_t pipe_config
;
392 uint64_t dcc_alignment
;
395 struct radeon_bo_list_item
{
396 struct pb_buffer
*buf
;
398 uint64_t priority_usage
; /* mask of (1 << RADEON_PRIO_*) */
401 struct radeon_winsys
{
403 * The screen object this winsys was created for
405 struct pipe_screen
*screen
;
408 * Decrement the winsys reference count.
410 * \param ws The winsys this function is called for.
411 * \return True if the winsys and screen should be destroyed.
413 bool (*unref
)(struct radeon_winsys
*ws
);
416 * Destroy this winsys.
418 * \param ws The winsys this function is called from.
420 void (*destroy
)(struct radeon_winsys
*ws
);
423 * Query an info structure from winsys.
425 * \param ws The winsys this function is called from.
426 * \param info Return structure
428 void (*query_info
)(struct radeon_winsys
*ws
,
429 struct radeon_info
*info
);
431 /**************************************************************************
432 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
434 * Remember that gallium gets to choose the interface it needs, and the
435 * window systems must then implement that interface (rather than the
436 * other way around...).
437 *************************************************************************/
440 * Create a buffer object.
442 * \param ws The winsys this function is called from.
443 * \param size The size to allocate.
444 * \param alignment An alignment of the buffer in memory.
445 * \param use_reusable_pool Whether the cache buffer manager should be used.
446 * \param domain A bitmask of the RADEON_DOMAIN_* flags.
447 * \return The created buffer object.
449 struct pb_buffer
*(*buffer_create
)(struct radeon_winsys
*ws
,
452 boolean use_reusable_pool
,
453 enum radeon_bo_domain domain
,
454 enum radeon_bo_flag flags
);
457 * Map the entire data store of a buffer object into the client's address
460 * \param buf A winsys buffer object to map.
461 * \param cs A command stream to flush if the buffer is referenced by it.
462 * \param usage A bitmask of the PIPE_TRANSFER_* flags.
463 * \return The pointer at the beginning of the buffer.
465 void *(*buffer_map
)(struct pb_buffer
*buf
,
466 struct radeon_winsys_cs
*cs
,
467 enum pipe_transfer_usage usage
);
470 * Unmap a buffer object from the client's address space.
472 * \param buf A winsys buffer object to unmap.
474 void (*buffer_unmap
)(struct pb_buffer
*buf
);
477 * Wait for the buffer and return true if the buffer is not used
480 * The timeout of 0 will only return the status.
481 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
484 bool (*buffer_wait
)(struct pb_buffer
*buf
, uint64_t timeout
,
485 enum radeon_bo_usage usage
);
488 * Return buffer metadata.
489 * (tiling info for display code, DRI sharing, and other data)
491 * \param buf A winsys buffer object to get the flags from.
494 void (*buffer_get_metadata
)(struct pb_buffer
*buf
,
495 struct radeon_bo_metadata
*md
);
498 * Set buffer metadata.
499 * (tiling info for display code, DRI sharing, and other data)
501 * \param buf A winsys buffer object to set the flags for.
504 void (*buffer_set_metadata
)(struct pb_buffer
*buf
,
505 struct radeon_bo_metadata
*md
);
508 * Get a winsys buffer from a winsys handle. The internal structure
509 * of the handle is platform-specific and only a winsys should access it.
511 * \param ws The winsys this function is called from.
512 * \param whandle A winsys handle pointer as was received from a state
514 * \param stride The returned buffer stride in bytes.
516 struct pb_buffer
*(*buffer_from_handle
)(struct radeon_winsys
*ws
,
517 struct winsys_handle
*whandle
,
521 * Get a winsys buffer from a user pointer. The resulting buffer can't
522 * be exported. Both pointer and size must be page aligned.
524 * \param ws The winsys this function is called from.
525 * \param pointer User pointer to turn into a buffer object.
526 * \param Size Size in bytes for the new buffer.
528 struct pb_buffer
*(*buffer_from_ptr
)(struct radeon_winsys
*ws
,
529 void *pointer
, unsigned size
);
532 * Whether the buffer was created from a user pointer.
534 * \param buf A winsys buffer object
535 * \return whether \p buf was created via buffer_from_ptr
537 bool (*buffer_is_user_ptr
)(struct pb_buffer
*buf
);
540 * Get a winsys handle from a winsys buffer. The internal structure
541 * of the handle is platform-specific and only a winsys should access it.
543 * \param buf A winsys buffer object to get the handle from.
544 * \param whandle A winsys handle pointer.
545 * \param stride A stride of the buffer in bytes, for texturing.
546 * \return TRUE on success.
548 boolean (*buffer_get_handle
)(struct pb_buffer
*buf
,
550 struct winsys_handle
*whandle
);
553 * Return the virtual address of a buffer.
555 * \param buf A winsys buffer object
556 * \return virtual address
558 uint64_t (*buffer_get_virtual_address
)(struct pb_buffer
*buf
);
561 * Query the initial placement of the buffer from the kernel driver.
563 enum radeon_bo_domain (*buffer_get_initial_domain
)(struct pb_buffer
*buf
);
565 /**************************************************************************
566 * Command submission.
568 * Each pipe context should create its own command stream and submit
569 * commands independently of other contexts.
570 *************************************************************************/
573 * Create a command submission context.
574 * Various command streams can be submitted to the same context.
576 struct radeon_winsys_ctx
*(*ctx_create
)(struct radeon_winsys
*ws
);
581 void (*ctx_destroy
)(struct radeon_winsys_ctx
*ctx
);
584 * Query a GPU reset status.
586 enum pipe_reset_status (*ctx_query_reset_status
)(struct radeon_winsys_ctx
*ctx
);
589 * Create a command stream.
591 * \param ctx The submission context
592 * \param ring_type The ring type (GFX, DMA, UVD)
593 * \param flush Flush callback function associated with the command stream.
594 * \param user User pointer that will be passed to the flush callback.
595 * \param trace_buf Trace buffer when tracing is enabled
597 struct radeon_winsys_cs
*(*cs_create
)(struct radeon_winsys_ctx
*ctx
,
598 enum ring_type ring_type
,
599 void (*flush
)(void *ctx
, unsigned flags
,
600 struct pipe_fence_handle
**fence
),
602 struct pb_buffer
*trace_buf
);
605 * Destroy a command stream.
607 * \param cs A command stream to destroy.
609 void (*cs_destroy
)(struct radeon_winsys_cs
*cs
);
612 * Add a buffer. Each buffer used by a CS must be added using this function.
614 * \param cs Command stream
616 * \param usage Whether the buffer is used for read and/or write.
617 * \param domain Bitmask of the RADEON_DOMAIN_* flags.
618 * \param priority A higher number means a greater chance of being
619 * placed in the requested domain. 15 is the maximum.
620 * \return Buffer index.
622 unsigned (*cs_add_buffer
)(struct radeon_winsys_cs
*cs
,
623 struct pb_buffer
*buf
,
624 enum radeon_bo_usage usage
,
625 enum radeon_bo_domain domain
,
626 enum radeon_bo_priority priority
);
629 * Return the index of an already-added buffer.
631 * \param cs Command stream
633 * \return The buffer index, or -1 if the buffer has not been added.
635 int (*cs_lookup_buffer
)(struct radeon_winsys_cs
*cs
,
636 struct pb_buffer
*buf
);
639 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
640 * added so far. If the validation fails, all buffers which have
641 * been added since the last call of cs_validate will be removed and
642 * the CS will be flushed (provided there are still any buffers).
644 * \param cs A command stream to validate.
646 boolean (*cs_validate
)(struct radeon_winsys_cs
*cs
);
649 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
652 * \param cs A command stream to validate.
653 * \param vram VRAM memory size pending to be use
654 * \param gtt GTT memory size pending to be use
656 boolean (*cs_memory_below_limit
)(struct radeon_winsys_cs
*cs
, uint64_t vram
, uint64_t gtt
);
659 * Return the buffer list.
661 * \param cs Command stream
662 * \param list Returned buffer list. Set to NULL to query the count only.
663 * \return The buffer count.
665 unsigned (*cs_get_buffer_list
)(struct radeon_winsys_cs
*cs
,
666 struct radeon_bo_list_item
*list
);
669 * Flush a command stream.
671 * \param cs A command stream to flush.
672 * \param flags, RADEON_FLUSH_ASYNC or 0.
673 * \param fence Pointer to a fence. If non-NULL, a fence is inserted
674 * after the CS and is returned through this parameter.
675 * \param cs_trace_id A unique identifier of the cs, used for tracing.
677 void (*cs_flush
)(struct radeon_winsys_cs
*cs
,
679 struct pipe_fence_handle
**fence
,
680 uint32_t cs_trace_id
);
683 * Return TRUE if a buffer is referenced by a command stream.
685 * \param cs A command stream.
686 * \param buf A winsys buffer.
688 boolean (*cs_is_buffer_referenced
)(struct radeon_winsys_cs
*cs
,
689 struct pb_buffer
*buf
,
690 enum radeon_bo_usage usage
);
693 * Request access to a feature for a command stream.
695 * \param cs A command stream.
696 * \param fid Feature ID, one of RADEON_FID_*
697 * \param enable Whether to enable or disable the feature.
699 boolean (*cs_request_feature
)(struct radeon_winsys_cs
*cs
,
700 enum radeon_feature_id fid
,
703 * Make sure all asynchronous flush of the cs have completed
705 * \param cs A command stream.
707 void (*cs_sync_flush
)(struct radeon_winsys_cs
*cs
);
710 * Wait for the fence and return true if the fence has been signalled.
711 * The timeout of 0 will only return the status.
712 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
715 bool (*fence_wait
)(struct radeon_winsys
*ws
,
716 struct pipe_fence_handle
*fence
,
720 * Reference counting for fences.
722 void (*fence_reference
)(struct pipe_fence_handle
**dst
,
723 struct pipe_fence_handle
*src
);
728 * \param ws The winsys this function is called from.
729 * \param surf Surface structure ptr
731 int (*surface_init
)(struct radeon_winsys
*ws
,
732 struct radeon_surf
*surf
);
735 * Find best values for a surface
737 * \param ws The winsys this function is called from.
738 * \param surf Surface structure ptr
740 int (*surface_best
)(struct radeon_winsys
*ws
,
741 struct radeon_surf
*surf
);
743 uint64_t (*query_value
)(struct radeon_winsys
*ws
,
744 enum radeon_value_id value
);
746 bool (*read_registers
)(struct radeon_winsys
*ws
, unsigned reg_offset
,
747 unsigned num_registers
, uint32_t *out
);
751 static inline void radeon_emit(struct radeon_winsys_cs
*cs
, uint32_t value
)
753 cs
->buf
[cs
->cdw
++] = value
;
756 static inline void radeon_emit_array(struct radeon_winsys_cs
*cs
,
757 const uint32_t *values
, unsigned count
)
759 memcpy(cs
->buf
+cs
->cdw
, values
, count
* 4);