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
{
229 unsigned cdw
; /* Number of used dwords. */
230 unsigned max_dw
; /* Maximum number of dwords. */
231 uint32_t *buf
; /* The command buffer. */
232 enum ring_type ring_type
;
236 /* PCI info: domain:bus:dev:func */
244 enum radeon_family family
;
245 enum chip_class chip_class
;
248 bool has_dedicated_vram
;
249 boolean has_virtual_memory
;
250 bool gfx_ib_pad_with_type2
;
253 uint32_t vce_fw_version
;
254 uint32_t vce_harvest_config
;
255 uint32_t clock_crystal_freq
;
258 uint32_t drm_major
; /* version */
260 uint32_t drm_patchlevel
;
264 uint32_t r600_max_quad_pipes
; /* wave size / 16 */
265 uint32_t max_shader_clock
;
266 uint32_t num_good_compute_units
;
267 uint32_t max_se
; /* shader engines */
268 uint32_t max_sh_per_se
; /* shader arrays per shader engine */
270 /* Render backends (color + depth blocks). */
271 uint32_t r300_num_gb_pipes
;
272 uint32_t r300_num_z_pipes
;
273 uint32_t r600_gb_backend_map
; /* R600 harvest config */
274 boolean r600_gb_backend_map_valid
;
275 uint32_t r600_num_banks
;
276 uint32_t num_render_backends
;
277 uint32_t num_tile_pipes
; /* pipe count from PIPE_CONFIG */
278 uint32_t pipe_interleave_bytes
;
279 uint32_t enabled_rb_mask
; /* GCN harvest config */
282 boolean si_tile_mode_array_valid
;
283 uint32_t si_tile_mode_array
[32];
284 boolean cik_macrotile_mode_array_valid
;
285 uint32_t cik_macrotile_mode_array
[16];
288 /* Tiling info for display code, DRI sharing, and other data. */
289 struct radeon_bo_metadata
{
290 /* Tiling flags describing the texture layout for display code
293 enum radeon_bo_layout microtile
;
294 enum radeon_bo_layout macrotile
;
295 unsigned pipe_config
;
299 unsigned stencil_tile_split
;
305 /* Additional metadata associated with the buffer, in bytes.
306 * The maximum size is 64 * 4. This is opaque for the winsys & kernel.
307 * Supported by amdgpu only.
309 uint32_t size_metadata
;
310 uint32_t metadata
[64];
313 enum radeon_feature_id
{
314 RADEON_FID_R300_HYPERZ_ACCESS
, /* ZMask + HiZ */
315 RADEON_FID_R300_CMASK_ACCESS
,
318 #define RADEON_SURF_MAX_LEVEL 32
320 #define RADEON_SURF_TYPE_MASK 0xFF
321 #define RADEON_SURF_TYPE_SHIFT 0
322 #define RADEON_SURF_TYPE_1D 0
323 #define RADEON_SURF_TYPE_2D 1
324 #define RADEON_SURF_TYPE_3D 2
325 #define RADEON_SURF_TYPE_CUBEMAP 3
326 #define RADEON_SURF_TYPE_1D_ARRAY 4
327 #define RADEON_SURF_TYPE_2D_ARRAY 5
328 #define RADEON_SURF_MODE_MASK 0xFF
329 #define RADEON_SURF_MODE_SHIFT 8
330 #define RADEON_SURF_MODE_LINEAR 0
331 #define RADEON_SURF_MODE_LINEAR_ALIGNED 1
332 #define RADEON_SURF_MODE_1D 2
333 #define RADEON_SURF_MODE_2D 3
334 #define RADEON_SURF_SCANOUT (1 << 16)
335 #define RADEON_SURF_ZBUFFER (1 << 17)
336 #define RADEON_SURF_SBUFFER (1 << 18)
337 #define RADEON_SURF_Z_OR_SBUFFER (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
338 #define RADEON_SURF_HAS_SBUFFER_MIPTREE (1 << 19)
339 #define RADEON_SURF_HAS_TILE_MODE_INDEX (1 << 20)
340 #define RADEON_SURF_FMASK (1 << 21)
342 #define RADEON_SURF_GET(v, field) (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
343 #define RADEON_SURF_SET(v, field) (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
344 #define RADEON_SURF_CLR(v, field) ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
346 struct radeon_surf_level
{
355 uint32_t pitch_bytes
;
361 /* These are inputs to the calculator. */
374 /* These are return values. Some of them can be set by the caller, but
375 * they will be treated as hints (e.g. bankw, bankh) and might be
376 * changed by the calculator.
379 uint64_t bo_alignment
;
380 /* This applies to EG and later. */
385 uint32_t stencil_tile_split
;
386 uint64_t stencil_offset
;
387 struct radeon_surf_level level
[RADEON_SURF_MAX_LEVEL
];
388 struct radeon_surf_level stencil_level
[RADEON_SURF_MAX_LEVEL
];
389 uint32_t tiling_index
[RADEON_SURF_MAX_LEVEL
];
390 uint32_t stencil_tiling_index
[RADEON_SURF_MAX_LEVEL
];
391 uint32_t pipe_config
;
395 uint64_t dcc_alignment
;
398 struct radeon_bo_list_item
{
399 struct pb_buffer
*buf
;
401 uint64_t priority_usage
; /* mask of (1 << RADEON_PRIO_*) */
404 struct radeon_winsys
{
406 * The screen object this winsys was created for
408 struct pipe_screen
*screen
;
411 * Decrement the winsys reference count.
413 * \param ws The winsys this function is called for.
414 * \return True if the winsys and screen should be destroyed.
416 bool (*unref
)(struct radeon_winsys
*ws
);
419 * Destroy this winsys.
421 * \param ws The winsys this function is called from.
423 void (*destroy
)(struct radeon_winsys
*ws
);
426 * Query an info structure from winsys.
428 * \param ws The winsys this function is called from.
429 * \param info Return structure
431 void (*query_info
)(struct radeon_winsys
*ws
,
432 struct radeon_info
*info
);
434 /**************************************************************************
435 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
437 * Remember that gallium gets to choose the interface it needs, and the
438 * window systems must then implement that interface (rather than the
439 * other way around...).
440 *************************************************************************/
443 * Create a buffer object.
445 * \param ws The winsys this function is called from.
446 * \param size The size to allocate.
447 * \param alignment An alignment of the buffer in memory.
448 * \param use_reusable_pool Whether the cache buffer manager should be used.
449 * \param domain A bitmask of the RADEON_DOMAIN_* flags.
450 * \return The created buffer object.
452 struct pb_buffer
*(*buffer_create
)(struct radeon_winsys
*ws
,
455 boolean use_reusable_pool
,
456 enum radeon_bo_domain domain
,
457 enum radeon_bo_flag flags
);
460 * Map the entire data store of a buffer object into the client's address
463 * \param buf A winsys buffer object to map.
464 * \param cs A command stream to flush if the buffer is referenced by it.
465 * \param usage A bitmask of the PIPE_TRANSFER_* flags.
466 * \return The pointer at the beginning of the buffer.
468 void *(*buffer_map
)(struct pb_buffer
*buf
,
469 struct radeon_winsys_cs
*cs
,
470 enum pipe_transfer_usage usage
);
473 * Unmap a buffer object from the client's address space.
475 * \param buf A winsys buffer object to unmap.
477 void (*buffer_unmap
)(struct pb_buffer
*buf
);
480 * Wait for the buffer and return true if the buffer is not used
483 * The timeout of 0 will only return the status.
484 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
487 bool (*buffer_wait
)(struct pb_buffer
*buf
, uint64_t timeout
,
488 enum radeon_bo_usage usage
);
491 * Return buffer metadata.
492 * (tiling info for display code, DRI sharing, and other data)
494 * \param buf A winsys buffer object to get the flags from.
497 void (*buffer_get_metadata
)(struct pb_buffer
*buf
,
498 struct radeon_bo_metadata
*md
);
501 * Set buffer metadata.
502 * (tiling info for display code, DRI sharing, and other data)
504 * \param buf A winsys buffer object to set the flags for.
507 void (*buffer_set_metadata
)(struct pb_buffer
*buf
,
508 struct radeon_bo_metadata
*md
);
511 * Get a winsys buffer from a winsys handle. The internal structure
512 * of the handle is platform-specific and only a winsys should access it.
514 * \param ws The winsys this function is called from.
515 * \param whandle A winsys handle pointer as was received from a state
517 * \param stride The returned buffer stride in bytes.
519 struct pb_buffer
*(*buffer_from_handle
)(struct radeon_winsys
*ws
,
520 struct winsys_handle
*whandle
,
521 unsigned *stride
, unsigned *offset
);
524 * Get a winsys buffer from a user pointer. The resulting buffer can't
525 * be exported. Both pointer and size must be page aligned.
527 * \param ws The winsys this function is called from.
528 * \param pointer User pointer to turn into a buffer object.
529 * \param Size Size in bytes for the new buffer.
531 struct pb_buffer
*(*buffer_from_ptr
)(struct radeon_winsys
*ws
,
532 void *pointer
, uint64_t size
);
535 * Whether the buffer was created from a user pointer.
537 * \param buf A winsys buffer object
538 * \return whether \p buf was created via buffer_from_ptr
540 bool (*buffer_is_user_ptr
)(struct pb_buffer
*buf
);
543 * Get a winsys handle from a winsys buffer. The internal structure
544 * of the handle is platform-specific and only a winsys should access it.
546 * \param buf A winsys buffer object to get the handle from.
547 * \param whandle A winsys handle pointer.
548 * \param stride A stride of the buffer in bytes, for texturing.
549 * \return TRUE on success.
551 boolean (*buffer_get_handle
)(struct pb_buffer
*buf
,
552 unsigned stride
, unsigned offset
,
554 struct winsys_handle
*whandle
);
557 * Return the virtual address of a buffer.
559 * \param buf A winsys buffer object
560 * \return virtual address
562 uint64_t (*buffer_get_virtual_address
)(struct pb_buffer
*buf
);
565 * Query the initial placement of the buffer from the kernel driver.
567 enum radeon_bo_domain (*buffer_get_initial_domain
)(struct pb_buffer
*buf
);
569 /**************************************************************************
570 * Command submission.
572 * Each pipe context should create its own command stream and submit
573 * commands independently of other contexts.
574 *************************************************************************/
577 * Create a command submission context.
578 * Various command streams can be submitted to the same context.
580 struct radeon_winsys_ctx
*(*ctx_create
)(struct radeon_winsys
*ws
);
585 void (*ctx_destroy
)(struct radeon_winsys_ctx
*ctx
);
588 * Query a GPU reset status.
590 enum pipe_reset_status (*ctx_query_reset_status
)(struct radeon_winsys_ctx
*ctx
);
593 * Create a command stream.
595 * \param ctx The submission context
596 * \param ring_type The ring type (GFX, DMA, UVD)
597 * \param flush Flush callback function associated with the command stream.
598 * \param user User pointer that will be passed to the flush callback.
600 struct radeon_winsys_cs
*(*cs_create
)(struct radeon_winsys_ctx
*ctx
,
601 enum ring_type ring_type
,
602 void (*flush
)(void *ctx
, unsigned flags
,
603 struct pipe_fence_handle
**fence
),
607 * Destroy a command stream.
609 * \param cs A command stream to destroy.
611 void (*cs_destroy
)(struct radeon_winsys_cs
*cs
);
614 * Add a buffer. Each buffer used by a CS must be added using this function.
616 * \param cs Command stream
618 * \param usage Whether the buffer is used for read and/or write.
619 * \param domain Bitmask of the RADEON_DOMAIN_* flags.
620 * \param priority A higher number means a greater chance of being
621 * placed in the requested domain. 15 is the maximum.
622 * \return Buffer index.
624 unsigned (*cs_add_buffer
)(struct radeon_winsys_cs
*cs
,
625 struct pb_buffer
*buf
,
626 enum radeon_bo_usage usage
,
627 enum radeon_bo_domain domain
,
628 enum radeon_bo_priority priority
);
631 * Return the index of an already-added buffer.
633 * \param cs Command stream
635 * \return The buffer index, or -1 if the buffer has not been added.
637 int (*cs_lookup_buffer
)(struct radeon_winsys_cs
*cs
,
638 struct pb_buffer
*buf
);
641 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
642 * added so far. If the validation fails, all buffers which have
643 * been added since the last call of cs_validate will be removed and
644 * the CS will be flushed (provided there are still any buffers).
646 * \param cs A command stream to validate.
648 boolean (*cs_validate
)(struct radeon_winsys_cs
*cs
);
651 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
654 * \param cs A command stream to validate.
655 * \param vram VRAM memory size pending to be use
656 * \param gtt GTT memory size pending to be use
658 boolean (*cs_memory_below_limit
)(struct radeon_winsys_cs
*cs
, uint64_t vram
, uint64_t gtt
);
661 * Return the buffer list.
663 * \param cs Command stream
664 * \param list Returned buffer list. Set to NULL to query the count only.
665 * \return The buffer count.
667 unsigned (*cs_get_buffer_list
)(struct radeon_winsys_cs
*cs
,
668 struct radeon_bo_list_item
*list
);
671 * Flush a command stream.
673 * \param cs A command stream to flush.
674 * \param flags, RADEON_FLUSH_ASYNC or 0.
675 * \param fence Pointer to a fence. If non-NULL, a fence is inserted
676 * after the CS and is returned through this parameter.
678 void (*cs_flush
)(struct radeon_winsys_cs
*cs
,
680 struct pipe_fence_handle
**fence
);
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);