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 /* R300 features in DRM.
33 * - GB_Z_PEQ_CONFIG on rv350->r4xx
34 * - R500 FG_ALPHA_VALUE
37 * - R500 US_FORMAT regs
38 * - R500 ARGB2101010 colorbuffer
43 #include "pipebuffer/pb_buffer.h"
45 #define RADEON_FLUSH_ASYNC (1 << 0)
46 #define RADEON_FLUSH_KEEP_TILING_FLAGS (1 << 1) /* needs DRM 2.12.0 */
47 #define RADEON_FLUSH_END_OF_FRAME (1 << 2)
50 enum radeon_bo_layout
{
51 RADEON_LAYOUT_LINEAR
= 0,
53 RADEON_LAYOUT_SQUARETILED
,
58 enum radeon_bo_domain
{ /* bitfield */
59 RADEON_DOMAIN_GTT
= 2,
60 RADEON_DOMAIN_VRAM
= 4,
61 RADEON_DOMAIN_VRAM_GTT
= RADEON_DOMAIN_VRAM
| RADEON_DOMAIN_GTT
64 enum radeon_bo_flag
{ /* bitfield */
65 RADEON_FLAG_GTT_WC
= (1 << 0),
66 RADEON_FLAG_CPU_ACCESS
= (1 << 1),
67 RADEON_FLAG_NO_CPU_ACCESS
= (1 << 2),
70 enum radeon_bo_usage
{ /* bitfield */
71 RADEON_USAGE_READ
= 2,
72 RADEON_USAGE_WRITE
= 4,
73 RADEON_USAGE_READWRITE
= RADEON_USAGE_READ
| RADEON_USAGE_WRITE
78 CHIP_R300
, /* R3xx-based cores. */
86 CHIP_R420
, /* R4xx-based cores. */
95 CHIP_RV515
, /* R5xx-based cores. */
167 enum radeon_value_id
{
168 RADEON_REQUESTED_VRAM_MEMORY
,
169 RADEON_REQUESTED_GTT_MEMORY
,
170 RADEON_BUFFER_WAIT_TIME_NS
,
172 RADEON_NUM_CS_FLUSHES
,
173 RADEON_NUM_BYTES_MOVED
,
176 RADEON_GPU_TEMPERATURE
, /* DRM 2.42.0 */
179 RADEON_GPU_RESET_COUNTER
, /* DRM 2.43.0 */
182 /* Each group of four has the same priority. */
183 enum radeon_bo_priority
{
184 RADEON_PRIO_FENCE
= 0,
186 RADEON_PRIO_SO_FILLED_SIZE
,
189 RADEON_PRIO_IB1
= 4, /* main IB submitted to the kernel */
190 RADEON_PRIO_IB2
, /* IB executed with INDIRECT_BUFFER */
191 RADEON_PRIO_DRAW_INDIRECT
,
192 RADEON_PRIO_INDEX_BUFFER
,
194 RADEON_PRIO_CP_DMA
= 8,
196 RADEON_PRIO_VCE
= 12,
198 RADEON_PRIO_SDMA_BUFFER
,
199 RADEON_PRIO_SDMA_TEXTURE
,
201 RADEON_PRIO_USER_SHADER
= 16,
202 RADEON_PRIO_INTERNAL_SHADER
, /* fetch shader, etc. */
206 RADEON_PRIO_CONST_BUFFER
= 24,
207 RADEON_PRIO_DESCRIPTORS
,
208 RADEON_PRIO_BORDER_COLORS
,
210 RADEON_PRIO_SAMPLER_BUFFER
= 28,
211 RADEON_PRIO_VERTEX_BUFFER
,
213 RADEON_PRIO_SHADER_RW_BUFFER
= 32,
214 RADEON_PRIO_RINGS_STREAMOUT
,
215 RADEON_PRIO_SCRATCH_BUFFER
,
216 RADEON_PRIO_COMPUTE_GLOBAL
,
218 RADEON_PRIO_SAMPLER_TEXTURE
= 36,
219 RADEON_PRIO_SHADER_RW_IMAGE
,
221 RADEON_PRIO_SAMPLER_TEXTURE_MSAA
= 40,
223 RADEON_PRIO_COLOR_BUFFER
= 44,
225 RADEON_PRIO_DEPTH_BUFFER
= 48,
227 RADEON_PRIO_COLOR_BUFFER_MSAA
= 52,
229 RADEON_PRIO_DEPTH_BUFFER_MSAA
= 56,
231 RADEON_PRIO_CMASK
= 60,
234 /* 63 is the maximum value */
237 struct winsys_handle
;
238 struct radeon_winsys_ctx
;
240 struct radeon_winsys_cs
{
241 unsigned cdw
; /* Number of used dwords. */
242 unsigned max_dw
; /* Maximum number of dwords. */
243 uint32_t *buf
; /* The command buffer. */
244 enum ring_type ring_type
;
249 enum radeon_family family
;
250 enum chip_class chip_class
;
254 uint32_t max_compute_units
;
256 uint32_t max_sh_per_se
;
258 uint32_t drm_major
; /* version */
260 uint32_t drm_patchlevel
;
263 uint32_t vce_fw_version
;
265 bool gfx_ib_pad_with_type2
;
267 uint32_t r300_num_gb_pipes
;
268 uint32_t r300_num_z_pipes
;
270 uint32_t r600_num_backends
;
271 uint32_t r600_clock_crystal_freq
;
272 uint32_t r600_tiling_config
;
273 uint32_t r600_num_tile_pipes
;
274 uint32_t r600_max_pipes
;
275 boolean r600_virtual_address
;
276 boolean r600_has_dma
;
278 uint32_t r600_backend_map
;
279 boolean r600_backend_map_valid
;
281 boolean si_tile_mode_array_valid
;
282 uint32_t si_tile_mode_array
[32];
283 uint32_t si_backend_enabled_mask
;
285 boolean cik_macrotile_mode_array_valid
;
286 uint32_t cik_macrotile_mode_array
[16];
287 uint32_t vce_harvest_config
;
290 enum radeon_feature_id
{
291 RADEON_FID_R300_HYPERZ_ACCESS
, /* ZMask + HiZ */
292 RADEON_FID_R300_CMASK_ACCESS
,
295 #define RADEON_SURF_MAX_LEVEL 32
297 #define RADEON_SURF_TYPE_MASK 0xFF
298 #define RADEON_SURF_TYPE_SHIFT 0
299 #define RADEON_SURF_TYPE_1D 0
300 #define RADEON_SURF_TYPE_2D 1
301 #define RADEON_SURF_TYPE_3D 2
302 #define RADEON_SURF_TYPE_CUBEMAP 3
303 #define RADEON_SURF_TYPE_1D_ARRAY 4
304 #define RADEON_SURF_TYPE_2D_ARRAY 5
305 #define RADEON_SURF_MODE_MASK 0xFF
306 #define RADEON_SURF_MODE_SHIFT 8
307 #define RADEON_SURF_MODE_LINEAR 0
308 #define RADEON_SURF_MODE_LINEAR_ALIGNED 1
309 #define RADEON_SURF_MODE_1D 2
310 #define RADEON_SURF_MODE_2D 3
311 #define RADEON_SURF_SCANOUT (1 << 16)
312 #define RADEON_SURF_ZBUFFER (1 << 17)
313 #define RADEON_SURF_SBUFFER (1 << 18)
314 #define RADEON_SURF_Z_OR_SBUFFER (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
315 #define RADEON_SURF_HAS_SBUFFER_MIPTREE (1 << 19)
316 #define RADEON_SURF_HAS_TILE_MODE_INDEX (1 << 20)
317 #define RADEON_SURF_FMASK (1 << 21)
319 #define RADEON_SURF_GET(v, field) (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
320 #define RADEON_SURF_SET(v, field) (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
321 #define RADEON_SURF_CLR(v, field) ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
323 struct radeon_surf_level
{
332 uint32_t pitch_bytes
;
338 /* These are inputs to the calculator. */
351 /* These are return values. Some of them can be set by the caller, but
352 * they will be treated as hints (e.g. bankw, bankh) and might be
353 * changed by the calculator.
356 uint64_t bo_alignment
;
357 /* This applies to EG and later. */
362 uint32_t stencil_tile_split
;
363 uint64_t stencil_offset
;
364 struct radeon_surf_level level
[RADEON_SURF_MAX_LEVEL
];
365 struct radeon_surf_level stencil_level
[RADEON_SURF_MAX_LEVEL
];
366 uint32_t tiling_index
[RADEON_SURF_MAX_LEVEL
];
367 uint32_t stencil_tiling_index
[RADEON_SURF_MAX_LEVEL
];
368 uint32_t pipe_config
;
372 uint64_t dcc_alignment
;
375 struct radeon_bo_list_item
{
376 struct pb_buffer
*buf
;
378 uint64_t priority_usage
; /* mask of (1 << RADEON_PRIO_*) */
381 struct radeon_winsys
{
383 * The screen object this winsys was created for
385 struct pipe_screen
*screen
;
388 * Decrement the winsys reference count.
390 * \param ws The winsys this function is called for.
391 * \return True if the winsys and screen should be destroyed.
393 bool (*unref
)(struct radeon_winsys
*ws
);
396 * Destroy this winsys.
398 * \param ws The winsys this function is called from.
400 void (*destroy
)(struct radeon_winsys
*ws
);
403 * Query an info structure from winsys.
405 * \param ws The winsys this function is called from.
406 * \param info Return structure
408 void (*query_info
)(struct radeon_winsys
*ws
,
409 struct radeon_info
*info
);
411 /**************************************************************************
412 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
414 * Remember that gallium gets to choose the interface it needs, and the
415 * window systems must then implement that interface (rather than the
416 * other way around...).
417 *************************************************************************/
420 * Create a buffer object.
422 * \param ws The winsys this function is called from.
423 * \param size The size to allocate.
424 * \param alignment An alignment of the buffer in memory.
425 * \param use_reusable_pool Whether the cache buffer manager should be used.
426 * \param domain A bitmask of the RADEON_DOMAIN_* flags.
427 * \return The created buffer object.
429 struct pb_buffer
*(*buffer_create
)(struct radeon_winsys
*ws
,
432 boolean use_reusable_pool
,
433 enum radeon_bo_domain domain
,
434 enum radeon_bo_flag flags
);
437 * Map the entire data store of a buffer object into the client's address
440 * \param buf A winsys buffer object to map.
441 * \param cs A command stream to flush if the buffer is referenced by it.
442 * \param usage A bitmask of the PIPE_TRANSFER_* flags.
443 * \return The pointer at the beginning of the buffer.
445 void *(*buffer_map
)(struct pb_buffer
*buf
,
446 struct radeon_winsys_cs
*cs
,
447 enum pipe_transfer_usage usage
);
450 * Unmap a buffer object from the client's address space.
452 * \param buf A winsys buffer object to unmap.
454 void (*buffer_unmap
)(struct pb_buffer
*buf
);
457 * Wait for the buffer and return true if the buffer is not used
460 * The timeout of 0 will only return the status.
461 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
464 bool (*buffer_wait
)(struct pb_buffer
*buf
, uint64_t timeout
,
465 enum radeon_bo_usage usage
);
468 * Return tiling flags describing a memory layout of a buffer object.
470 * \param buf A winsys buffer object to get the flags from.
471 * \param macrotile A pointer to the return value of the microtile flag.
472 * \param microtile A pointer to the return value of the macrotile flag.
474 * \note microtile and macrotile are not bitmasks!
476 void (*buffer_get_tiling
)(struct pb_buffer
*buf
,
477 enum radeon_bo_layout
*microtile
,
478 enum radeon_bo_layout
*macrotile
,
479 unsigned *bankw
, unsigned *bankh
,
480 unsigned *tile_split
,
481 unsigned *stencil_tile_split
,
486 * Set tiling flags describing a memory layout of a buffer object.
488 * \param buf A winsys buffer object to set the flags for.
489 * \param cs A command stream to flush if the buffer is referenced by it.
490 * \param macrotile A macrotile flag.
491 * \param microtile A microtile flag.
492 * \param stride A stride of the buffer in bytes, for texturing.
494 * \note microtile and macrotile are not bitmasks!
496 void (*buffer_set_tiling
)(struct pb_buffer
*buf
,
497 struct radeon_winsys_cs
*rcs
,
498 enum radeon_bo_layout microtile
,
499 enum radeon_bo_layout macrotile
,
500 unsigned pipe_config
,
501 unsigned bankw
, unsigned bankh
,
503 unsigned stencil_tile_split
,
504 unsigned mtilea
, unsigned num_banks
,
509 * Get a winsys buffer from a winsys handle. The internal structure
510 * of the handle is platform-specific and only a winsys should access it.
512 * \param ws The winsys this function is called from.
513 * \param whandle A winsys handle pointer as was received from a state
515 * \param stride The returned buffer stride in bytes.
517 struct pb_buffer
*(*buffer_from_handle
)(struct radeon_winsys
*ws
,
518 struct winsys_handle
*whandle
,
522 * Get a winsys buffer from a user pointer. The resulting buffer can't
523 * be exported. Both pointer and size must be page aligned.
525 * \param ws The winsys this function is called from.
526 * \param pointer User pointer to turn into a buffer object.
527 * \param Size Size in bytes for the new buffer.
529 struct pb_buffer
*(*buffer_from_ptr
)(struct radeon_winsys
*ws
,
530 void *pointer
, unsigned size
);
533 * Whether the buffer was created from a user pointer.
535 * \param buf A winsys buffer object
536 * \return whether \p buf was created via buffer_from_ptr
538 bool (*buffer_is_user_ptr
)(struct pb_buffer
*buf
);
541 * Get a winsys handle from a winsys buffer. The internal structure
542 * of the handle is platform-specific and only a winsys should access it.
544 * \param buf A winsys buffer object to get the handle from.
545 * \param whandle A winsys handle pointer.
546 * \param stride A stride of the buffer in bytes, for texturing.
547 * \return TRUE on success.
549 boolean (*buffer_get_handle
)(struct pb_buffer
*buf
,
551 struct winsys_handle
*whandle
);
554 * Return the virtual address of a buffer.
556 * \param buf A winsys buffer object
557 * \return virtual address
559 uint64_t (*buffer_get_virtual_address
)(struct pb_buffer
*buf
);
562 * Query the initial placement of the buffer from the kernel driver.
564 enum radeon_bo_domain (*buffer_get_initial_domain
)(struct pb_buffer
*buf
);
566 /**************************************************************************
567 * Command submission.
569 * Each pipe context should create its own command stream and submit
570 * commands independently of other contexts.
571 *************************************************************************/
574 * Create a command submission context.
575 * Various command streams can be submitted to the same context.
577 struct radeon_winsys_ctx
*(*ctx_create
)(struct radeon_winsys
*ws
);
582 void (*ctx_destroy
)(struct radeon_winsys_ctx
*ctx
);
585 * Query a GPU reset status.
587 enum pipe_reset_status (*ctx_query_reset_status
)(struct radeon_winsys_ctx
*ctx
);
590 * Create a command stream.
592 * \param ctx The submission context
593 * \param ring_type The ring type (GFX, DMA, UVD)
594 * \param flush Flush callback function associated with the command stream.
595 * \param user User pointer that will be passed to the flush callback.
596 * \param trace_buf Trace buffer when tracing is enabled
598 struct radeon_winsys_cs
*(*cs_create
)(struct radeon_winsys_ctx
*ctx
,
599 enum ring_type ring_type
,
600 void (*flush
)(void *ctx
, unsigned flags
,
601 struct pipe_fence_handle
**fence
),
603 struct pb_buffer
*trace_buf
);
606 * Destroy a command stream.
608 * \param cs A command stream to destroy.
610 void (*cs_destroy
)(struct radeon_winsys_cs
*cs
);
613 * Add a buffer. Each buffer used by a CS must be added using this function.
615 * \param cs Command stream
617 * \param usage Whether the buffer is used for read and/or write.
618 * \param domain Bitmask of the RADEON_DOMAIN_* flags.
619 * \param priority A higher number means a greater chance of being
620 * placed in the requested domain. 15 is the maximum.
621 * \return Buffer index.
623 unsigned (*cs_add_buffer
)(struct radeon_winsys_cs
*cs
,
624 struct pb_buffer
*buf
,
625 enum radeon_bo_usage usage
,
626 enum radeon_bo_domain domain
,
627 enum radeon_bo_priority priority
);
630 * Return the index of an already-added buffer.
632 * \param cs Command stream
634 * \return The buffer index, or -1 if the buffer has not been added.
636 int (*cs_lookup_buffer
)(struct radeon_winsys_cs
*cs
,
637 struct pb_buffer
*buf
);
640 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
641 * added so far. If the validation fails, all buffers which have
642 * been added since the last call of cs_validate will be removed and
643 * the CS will be flushed (provided there are still any buffers).
645 * \param cs A command stream to validate.
647 boolean (*cs_validate
)(struct radeon_winsys_cs
*cs
);
650 * Return TRUE if there is enough memory in VRAM and GTT for the buffers
653 * \param cs A command stream to validate.
654 * \param vram VRAM memory size pending to be use
655 * \param gtt GTT memory size pending to be use
657 boolean (*cs_memory_below_limit
)(struct radeon_winsys_cs
*cs
, uint64_t vram
, uint64_t gtt
);
660 * Return the buffer list.
662 * \param cs Command stream
663 * \param list Returned buffer list. Set to NULL to query the count only.
664 * \return The buffer count.
666 unsigned (*cs_get_buffer_list
)(struct radeon_winsys_cs
*cs
,
667 struct radeon_bo_list_item
*list
);
670 * Flush a command stream.
672 * \param cs A command stream to flush.
673 * \param flags, RADEON_FLUSH_ASYNC or 0.
674 * \param fence Pointer to a fence. If non-NULL, a fence is inserted
675 * after the CS and is returned through this parameter.
676 * \param cs_trace_id A unique identifier of the cs, used for tracing.
678 void (*cs_flush
)(struct radeon_winsys_cs
*cs
,
680 struct pipe_fence_handle
**fence
,
681 uint32_t cs_trace_id
);
684 * Return TRUE if a buffer is referenced by a command stream.
686 * \param cs A command stream.
687 * \param buf A winsys buffer.
689 boolean (*cs_is_buffer_referenced
)(struct radeon_winsys_cs
*cs
,
690 struct pb_buffer
*buf
,
691 enum radeon_bo_usage usage
);
694 * Request access to a feature for a command stream.
696 * \param cs A command stream.
697 * \param fid Feature ID, one of RADEON_FID_*
698 * \param enable Whether to enable or disable the feature.
700 boolean (*cs_request_feature
)(struct radeon_winsys_cs
*cs
,
701 enum radeon_feature_id fid
,
704 * Make sure all asynchronous flush of the cs have completed
706 * \param cs A command stream.
708 void (*cs_sync_flush
)(struct radeon_winsys_cs
*cs
);
711 * Wait for the fence and return true if the fence has been signalled.
712 * The timeout of 0 will only return the status.
713 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
716 bool (*fence_wait
)(struct radeon_winsys
*ws
,
717 struct pipe_fence_handle
*fence
,
721 * Reference counting for fences.
723 void (*fence_reference
)(struct pipe_fence_handle
**dst
,
724 struct pipe_fence_handle
*src
);
729 * \param ws The winsys this function is called from.
730 * \param surf Surface structure ptr
732 int (*surface_init
)(struct radeon_winsys
*ws
,
733 struct radeon_surf
*surf
);
736 * Find best values for a surface
738 * \param ws The winsys this function is called from.
739 * \param surf Surface structure ptr
741 int (*surface_best
)(struct radeon_winsys
*ws
,
742 struct radeon_surf
*surf
);
744 uint64_t (*query_value
)(struct radeon_winsys
*ws
,
745 enum radeon_value_id value
);
747 bool (*read_registers
)(struct radeon_winsys
*ws
, unsigned reg_offset
,
748 unsigned num_registers
, uint32_t *out
);
752 static inline void radeon_emit(struct radeon_winsys_cs
*cs
, uint32_t value
)
754 cs
->buf
[cs
->cdw
++] = value
;
757 static inline void radeon_emit_array(struct radeon_winsys_cs
*cs
,
758 const uint32_t *values
, unsigned count
)
760 memcpy(cs
->buf
+cs
->cdw
, values
, count
* 4);