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. */
155 enum radeon_value_id
{
156 RADEON_REQUESTED_VRAM_MEMORY
,
157 RADEON_REQUESTED_GTT_MEMORY
,
158 RADEON_BUFFER_WAIT_TIME_NS
,
160 RADEON_NUM_CS_FLUSHES
,
161 RADEON_NUM_BYTES_MOVED
,
164 RADEON_GPU_TEMPERATURE
, /* DRM 2.42.0 */
167 RADEON_GPU_RESET_COUNTER
, /* DRM 2.43.0 */
170 /* Each group of four has the same priority. */
171 enum radeon_bo_priority
{
172 RADEON_PRIO_FENCE
= 0,
174 RADEON_PRIO_SO_FILLED_SIZE
,
177 RADEON_PRIO_IB1
= 4, /* main IB submitted to the kernel */
178 RADEON_PRIO_IB2
, /* IB executed with INDIRECT_BUFFER */
179 RADEON_PRIO_DRAW_INDIRECT
,
180 RADEON_PRIO_INDEX_BUFFER
,
182 RADEON_PRIO_CP_DMA
= 8,
184 RADEON_PRIO_VCE
= 12,
186 RADEON_PRIO_SDMA_BUFFER
,
187 RADEON_PRIO_SDMA_TEXTURE
,
189 RADEON_PRIO_USER_SHADER
= 16,
190 RADEON_PRIO_INTERNAL_SHADER
, /* fetch shader, etc. */
194 RADEON_PRIO_CONST_BUFFER
= 24,
195 RADEON_PRIO_DESCRIPTORS
,
196 RADEON_PRIO_BORDER_COLORS
,
198 RADEON_PRIO_SAMPLER_BUFFER
= 28,
199 RADEON_PRIO_VERTEX_BUFFER
,
201 RADEON_PRIO_SHADER_RW_BUFFER
= 32,
202 RADEON_PRIO_RINGS_STREAMOUT
,
203 RADEON_PRIO_SCRATCH_BUFFER
,
204 RADEON_PRIO_COMPUTE_GLOBAL
,
206 RADEON_PRIO_SAMPLER_TEXTURE
= 36,
207 RADEON_PRIO_SHADER_RW_IMAGE
,
209 RADEON_PRIO_SAMPLER_TEXTURE_MSAA
= 40,
211 RADEON_PRIO_COLOR_BUFFER
= 44,
213 RADEON_PRIO_DEPTH_BUFFER
= 48,
215 RADEON_PRIO_COLOR_BUFFER_MSAA
= 52,
217 RADEON_PRIO_DEPTH_BUFFER_MSAA
= 56,
219 RADEON_PRIO_CMASK
= 60,
222 /* 63 is the maximum value */
225 struct winsys_handle
;
226 struct radeon_winsys_ctx
;
228 struct radeon_winsys_cs_chunk
{
229 unsigned cdw
; /* Number of used dwords. */
230 unsigned max_dw
; /* Maximum number of dwords. */
231 uint32_t *buf
; /* The base pointer of the chunk. */
234 struct radeon_winsys_cs
{
235 struct radeon_winsys_cs_chunk current
;
236 struct radeon_winsys_cs_chunk
*prev
;
237 unsigned num_prev
; /* Number of previous chunks. */
238 unsigned max_prev
; /* Space in array pointed to by prev. */
239 unsigned prev_dw
; /* Total number of dwords in previous chunks. */
243 /* PCI info: domain:bus:dev:func */
251 enum radeon_family family
;
252 enum chip_class chip_class
;
253 uint32_t gart_page_size
;
256 bool has_dedicated_vram
;
257 boolean has_virtual_memory
;
258 bool gfx_ib_pad_with_type2
;
261 uint32_t vce_fw_version
;
262 uint32_t vce_harvest_config
;
263 uint32_t clock_crystal_freq
;
266 uint32_t drm_major
; /* version */
268 uint32_t drm_patchlevel
;
272 uint32_t r600_max_quad_pipes
; /* wave size / 16 */
273 uint32_t max_shader_clock
;
274 uint32_t num_good_compute_units
;
275 uint32_t max_se
; /* shader engines */
276 uint32_t max_sh_per_se
; /* shader arrays per shader engine */
278 /* Render backends (color + depth blocks). */
279 uint32_t r300_num_gb_pipes
;
280 uint32_t r300_num_z_pipes
;
281 uint32_t r600_gb_backend_map
; /* R600 harvest config */
282 boolean r600_gb_backend_map_valid
;
283 uint32_t r600_num_banks
;
284 uint32_t num_render_backends
;
285 uint32_t num_tile_pipes
; /* pipe count from PIPE_CONFIG */
286 uint32_t pipe_interleave_bytes
;
287 uint32_t enabled_rb_mask
; /* GCN harvest config */
290 uint32_t si_tile_mode_array
[32];
291 uint32_t cik_macrotile_mode_array
[16];
294 /* Tiling info for display code, DRI sharing, and other data. */
295 struct radeon_bo_metadata
{
296 /* Tiling flags describing the texture layout for display code
299 enum radeon_bo_layout microtile
;
300 enum radeon_bo_layout macrotile
;
301 unsigned pipe_config
;
310 /* Additional metadata associated with the buffer, in bytes.
311 * The maximum size is 64 * 4. This is opaque for the winsys & kernel.
312 * Supported by amdgpu only.
314 uint32_t size_metadata
;
315 uint32_t metadata
[64];
318 enum radeon_feature_id
{
319 RADEON_FID_R300_HYPERZ_ACCESS
, /* ZMask + HiZ */
320 RADEON_FID_R300_CMASK_ACCESS
,
323 #define RADEON_SURF_MAX_LEVEL 32
325 #define RADEON_SURF_TYPE_MASK 0xFF
326 #define RADEON_SURF_TYPE_SHIFT 0
327 #define RADEON_SURF_TYPE_1D 0
328 #define RADEON_SURF_TYPE_2D 1
329 #define RADEON_SURF_TYPE_3D 2
330 #define RADEON_SURF_TYPE_CUBEMAP 3
331 #define RADEON_SURF_TYPE_1D_ARRAY 4
332 #define RADEON_SURF_TYPE_2D_ARRAY 5
333 #define RADEON_SURF_MODE_MASK 0xFF
334 #define RADEON_SURF_MODE_SHIFT 8
335 #define RADEON_SURF_MODE_LINEAR_ALIGNED 1
336 #define RADEON_SURF_MODE_1D 2
337 #define RADEON_SURF_MODE_2D 3
338 #define RADEON_SURF_SCANOUT (1 << 16)
339 #define RADEON_SURF_ZBUFFER (1 << 17)
340 #define RADEON_SURF_SBUFFER (1 << 18)
341 #define RADEON_SURF_Z_OR_SBUFFER (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
342 #define RADEON_SURF_HAS_SBUFFER_MIPTREE (1 << 19)
343 #define RADEON_SURF_HAS_TILE_MODE_INDEX (1 << 20)
344 #define RADEON_SURF_FMASK (1 << 21)
345 #define RADEON_SURF_DISABLE_DCC (1 << 22)
347 #define RADEON_SURF_GET(v, field) (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
348 #define RADEON_SURF_SET(v, field) (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
349 #define RADEON_SURF_CLR(v, field) ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
351 struct radeon_surf_level
{
360 uint32_t pitch_bytes
;
363 uint64_t dcc_fast_clear_size
;
368 /* These are inputs to the calculator. */
381 /* These are return values. Some of them can be set by the caller, but
382 * they will be treated as hints (e.g. bankw, bankh) and might be
383 * changed by the calculator.
386 uint64_t bo_alignment
;
387 /* This applies to EG and later. */
392 uint32_t stencil_tile_split
;
393 uint64_t stencil_offset
;
394 struct radeon_surf_level level
[RADEON_SURF_MAX_LEVEL
];
395 struct radeon_surf_level stencil_level
[RADEON_SURF_MAX_LEVEL
];
396 uint32_t tiling_index
[RADEON_SURF_MAX_LEVEL
];
397 uint32_t stencil_tiling_index
[RADEON_SURF_MAX_LEVEL
];
398 uint32_t pipe_config
;
400 uint32_t macro_tile_index
;
403 uint64_t dcc_alignment
;
406 struct radeon_bo_list_item
{
407 struct pb_buffer
*buf
;
409 uint64_t priority_usage
; /* mask of (1 << RADEON_PRIO_*) */
412 struct radeon_winsys
{
414 * The screen object this winsys was created for
416 struct pipe_screen
*screen
;
419 * Decrement the winsys reference count.
421 * \param ws The winsys this function is called for.
422 * \return True if the winsys and screen should be destroyed.
424 bool (*unref
)(struct radeon_winsys
*ws
);
427 * Destroy this winsys.
429 * \param ws The winsys this function is called from.
431 void (*destroy
)(struct radeon_winsys
*ws
);
434 * Query an info structure from winsys.
436 * \param ws The winsys this function is called from.
437 * \param info Return structure
439 void (*query_info
)(struct radeon_winsys
*ws
,
440 struct radeon_info
*info
);
442 /**************************************************************************
443 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
445 * Remember that gallium gets to choose the interface it needs, and the
446 * window systems must then implement that interface (rather than the
447 * other way around...).
448 *************************************************************************/
451 * Create a buffer object.
453 * \param ws The winsys this function is called from.
454 * \param size The size to allocate.
455 * \param alignment An alignment of the buffer in memory.
456 * \param use_reusable_pool Whether the cache buffer manager should be used.
457 * \param domain A bitmask of the RADEON_DOMAIN_* flags.
458 * \return The created buffer object.
460 struct pb_buffer
*(*buffer_create
)(struct radeon_winsys
*ws
,
463 enum radeon_bo_domain domain
,
464 enum radeon_bo_flag flags
);
467 * Map the entire data store of a buffer object into the client's address
470 * \param buf A winsys buffer object to map.
471 * \param cs A command stream to flush if the buffer is referenced by it.
472 * \param usage A bitmask of the PIPE_TRANSFER_* flags.
473 * \return The pointer at the beginning of the buffer.
475 void *(*buffer_map
)(struct pb_buffer
*buf
,
476 struct radeon_winsys_cs
*cs
,
477 enum pipe_transfer_usage usage
);
480 * Unmap a buffer object from the client's address space.
482 * \param buf A winsys buffer object to unmap.
484 void (*buffer_unmap
)(struct pb_buffer
*buf
);
487 * Wait for the buffer and return true if the buffer is not used
490 * The timeout of 0 will only return the status.
491 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
494 bool (*buffer_wait
)(struct pb_buffer
*buf
, uint64_t timeout
,
495 enum radeon_bo_usage usage
);
498 * Return buffer metadata.
499 * (tiling info for display code, DRI sharing, and other data)
501 * \param buf A winsys buffer object to get the flags from.
504 void (*buffer_get_metadata
)(struct pb_buffer
*buf
,
505 struct radeon_bo_metadata
*md
);
508 * Set buffer metadata.
509 * (tiling info for display code, DRI sharing, and other data)
511 * \param buf A winsys buffer object to set the flags for.
514 void (*buffer_set_metadata
)(struct pb_buffer
*buf
,
515 struct radeon_bo_metadata
*md
);
518 * Get a winsys buffer from a winsys handle. The internal structure
519 * of the handle is platform-specific and only a winsys should access it.
521 * \param ws The winsys this function is called from.
522 * \param whandle A winsys handle pointer as was received from a state
524 * \param stride The returned buffer stride in bytes.
526 struct pb_buffer
*(*buffer_from_handle
)(struct radeon_winsys
*ws
,
527 struct winsys_handle
*whandle
,
528 unsigned *stride
, unsigned *offset
);
531 * Get a winsys buffer from a user pointer. The resulting buffer can't
532 * be exported. Both pointer and size must be page aligned.
534 * \param ws The winsys this function is called from.
535 * \param pointer User pointer to turn into a buffer object.
536 * \param Size Size in bytes for the new buffer.
538 struct pb_buffer
*(*buffer_from_ptr
)(struct radeon_winsys
*ws
,
539 void *pointer
, uint64_t size
);
542 * Whether the buffer was created from a user pointer.
544 * \param buf A winsys buffer object
545 * \return whether \p buf was created via buffer_from_ptr
547 bool (*buffer_is_user_ptr
)(struct pb_buffer
*buf
);
550 * Get a winsys handle from a winsys buffer. The internal structure
551 * of the handle is platform-specific and only a winsys should access it.
553 * \param buf A winsys buffer object to get the handle from.
554 * \param whandle A winsys handle pointer.
555 * \param stride A stride of the buffer in bytes, for texturing.
556 * \return TRUE on success.
558 boolean (*buffer_get_handle
)(struct pb_buffer
*buf
,
559 unsigned stride
, unsigned offset
,
561 struct winsys_handle
*whandle
);
564 * Return the virtual address of a buffer.
566 * \param buf A winsys buffer object
567 * \return virtual address
569 uint64_t (*buffer_get_virtual_address
)(struct pb_buffer
*buf
);
572 * Query the initial placement of the buffer from the kernel driver.
574 enum radeon_bo_domain (*buffer_get_initial_domain
)(struct pb_buffer
*buf
);
576 /**************************************************************************
577 * Command submission.
579 * Each pipe context should create its own command stream and submit
580 * commands independently of other contexts.
581 *************************************************************************/
584 * Create a command submission context.
585 * Various command streams can be submitted to the same context.
587 struct radeon_winsys_ctx
*(*ctx_create
)(struct radeon_winsys
*ws
);
592 void (*ctx_destroy
)(struct radeon_winsys_ctx
*ctx
);
595 * Query a GPU reset status.
597 enum pipe_reset_status (*ctx_query_reset_status
)(struct radeon_winsys_ctx
*ctx
);
600 * Create a command stream.
602 * \param ctx The submission context
603 * \param ring_type The ring type (GFX, DMA, UVD)
604 * \param flush Flush callback function associated with the command stream.
605 * \param user User pointer that will be passed to the flush callback.
607 struct radeon_winsys_cs
*(*cs_create
)(struct radeon_winsys_ctx
*ctx
,
608 enum ring_type ring_type
,
609 void (*flush
)(void *ctx
, unsigned flags
,
610 struct pipe_fence_handle
**fence
),
614 * Add a constant engine IB to a graphics CS. This makes the graphics CS
615 * from "cs_create" a group of two IBs that share a buffer list and are
618 * The returned constant CS is only a stream for writing packets to the new
619 * IB. Calling other winsys functions with it is not allowed, not even
622 * In order to add buffers and check memory usage, use the graphics CS.
623 * In order to flush it, use the graphics CS, which will flush both IBs.
624 * Destroying the graphics CS will destroy both of them.
626 * \param cs The graphics CS from "cs_create" that will hold the buffer
627 * list and will be used for flushing.
629 struct radeon_winsys_cs
*(*cs_add_const_ib
)(struct radeon_winsys_cs
*cs
);
632 * Add a constant engine preamble IB to a graphics CS. This add an extra IB
633 * in similar manner to cs_add_const_ib. This should always be called after
636 * The returned IB is a constant engine IB that only gets flushed if the
639 * \param cs The graphics CS from "cs_create" that will hold the buffer
640 * list and will be used for flushing.
642 struct radeon_winsys_cs
*(*cs_add_const_preamble_ib
)(struct radeon_winsys_cs
*cs
);
644 * Destroy a command stream.
646 * \param cs A command stream to destroy.
648 void (*cs_destroy
)(struct radeon_winsys_cs
*cs
);
651 * Add a buffer. Each buffer used by a CS must be added using this function.
653 * \param cs Command stream
655 * \param usage Whether the buffer is used for read and/or write.
656 * \param domain Bitmask of the RADEON_DOMAIN_* flags.
657 * \param priority A higher number means a greater chance of being
658 * placed in the requested domain. 15 is the maximum.
659 * \return Buffer index.
661 unsigned (*cs_add_buffer
)(struct radeon_winsys_cs
*cs
,
662 struct pb_buffer
*buf
,
663 enum radeon_bo_usage usage
,
664 enum radeon_bo_domain domain
,
665 enum radeon_bo_priority priority
);
668 * Return the index of an already-added buffer.
670 * \param cs Command stream
672 * \return The buffer index, or -1 if the buffer has not been added.
674 int (*cs_lookup_buffer
)(struct radeon_winsys_cs
*cs
,
675 struct pb_buffer
*buf
);
678 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
679 * added so far. If the validation fails, all buffers which have
680 * been added since the last call of cs_validate will be removed and
681 * the CS will be flushed (provided there are still any buffers).
683 * \param cs A command stream to validate.
685 boolean (*cs_validate
)(struct radeon_winsys_cs
*cs
);
688 * Check whether the given number of dwords is available in the IB.
689 * Optionally chain a new chunk of the IB if necessary and supported.
691 * \param cs A command stream.
692 * \param dw Number of CS dwords requested by the caller.
694 bool (*cs_check_space
)(struct radeon_winsys_cs
*cs
, unsigned dw
);
697 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
700 * \param cs A command stream to validate.
701 * \param vram VRAM memory size pending to be use
702 * \param gtt GTT memory size pending to be use
704 boolean (*cs_memory_below_limit
)(struct radeon_winsys_cs
*cs
, uint64_t vram
, uint64_t gtt
);
706 uint64_t (*cs_query_memory_usage
)(struct radeon_winsys_cs
*cs
);
709 * Return the buffer list.
711 * \param cs Command stream
712 * \param list Returned buffer list. Set to NULL to query the count only.
713 * \return The buffer count.
715 unsigned (*cs_get_buffer_list
)(struct radeon_winsys_cs
*cs
,
716 struct radeon_bo_list_item
*list
);
719 * Flush a command stream.
721 * \param cs A command stream to flush.
722 * \param flags, RADEON_FLUSH_ASYNC or 0.
723 * \param fence Pointer to a fence. If non-NULL, a fence is inserted
724 * after the CS and is returned through this parameter.
726 void (*cs_flush
)(struct radeon_winsys_cs
*cs
,
728 struct pipe_fence_handle
**fence
);
731 * Return TRUE if a buffer is referenced by a command stream.
733 * \param cs A command stream.
734 * \param buf A winsys buffer.
736 boolean (*cs_is_buffer_referenced
)(struct radeon_winsys_cs
*cs
,
737 struct pb_buffer
*buf
,
738 enum radeon_bo_usage usage
);
741 * Request access to a feature for a command stream.
743 * \param cs A command stream.
744 * \param fid Feature ID, one of RADEON_FID_*
745 * \param enable Whether to enable or disable the feature.
747 boolean (*cs_request_feature
)(struct radeon_winsys_cs
*cs
,
748 enum radeon_feature_id fid
,
751 * Make sure all asynchronous flush of the cs have completed
753 * \param cs A command stream.
755 void (*cs_sync_flush
)(struct radeon_winsys_cs
*cs
);
758 * Wait for the fence and return true if the fence has been signalled.
759 * The timeout of 0 will only return the status.
760 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
763 bool (*fence_wait
)(struct radeon_winsys
*ws
,
764 struct pipe_fence_handle
*fence
,
768 * Reference counting for fences.
770 void (*fence_reference
)(struct pipe_fence_handle
**dst
,
771 struct pipe_fence_handle
*src
);
776 * \param ws The winsys this function is called from.
777 * \param surf Surface structure ptr
779 int (*surface_init
)(struct radeon_winsys
*ws
,
780 struct radeon_surf
*surf
);
783 * Find best values for a surface
785 * \param ws The winsys this function is called from.
786 * \param surf Surface structure ptr
788 int (*surface_best
)(struct radeon_winsys
*ws
,
789 struct radeon_surf
*surf
);
791 uint64_t (*query_value
)(struct radeon_winsys
*ws
,
792 enum radeon_value_id value
);
794 bool (*read_registers
)(struct radeon_winsys
*ws
, unsigned reg_offset
,
795 unsigned num_registers
, uint32_t *out
);
798 static inline bool radeon_emitted(struct radeon_winsys_cs
*cs
, unsigned num_dw
)
800 return cs
&& (cs
->prev_dw
+ cs
->current
.cdw
> num_dw
);
803 static inline void radeon_emit(struct radeon_winsys_cs
*cs
, uint32_t value
)
805 cs
->current
.buf
[cs
->current
.cdw
++] = value
;
808 static inline void radeon_emit_array(struct radeon_winsys_cs
*cs
,
809 const uint32_t *values
, unsigned count
)
811 memcpy(cs
->current
.buf
+ cs
->current
.cdw
, values
, count
* 4);
812 cs
->current
.cdw
+= count
;