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. */
166 enum radeon_value_id
{
167 RADEON_REQUESTED_VRAM_MEMORY
,
168 RADEON_REQUESTED_GTT_MEMORY
,
169 RADEON_BUFFER_WAIT_TIME_NS
,
171 RADEON_NUM_CS_FLUSHES
,
172 RADEON_NUM_BYTES_MOVED
,
175 RADEON_GPU_TEMPERATURE
, /* DRM 2.42.0 */
178 RADEON_GPU_RESET_COUNTER
, /* DRM 2.43.0 */
181 enum radeon_bo_priority
{
183 RADEON_PRIO_SHADER_DATA
, /* shader code, resource descriptors */
184 RADEON_PRIO_SHADER_BUFFER_RO
, /* read-only */
185 RADEON_PRIO_SHADER_TEXTURE_RO
, /* read-only */
186 RADEON_PRIO_SHADER_RESOURCE_RW
, /* buffers, textures, streamout, GS rings, RATs; read/write */
187 RADEON_PRIO_COLOR_BUFFER
,
188 RADEON_PRIO_DEPTH_BUFFER
,
189 RADEON_PRIO_SHADER_TEXTURE_MSAA
,
190 RADEON_PRIO_COLOR_BUFFER_MSAA
,
191 RADEON_PRIO_DEPTH_BUFFER_MSAA
,
192 RADEON_PRIO_COLOR_META
,
193 RADEON_PRIO_DEPTH_META
,
194 RADEON_PRIO_MAX
/* must be <= 15 */
197 struct winsys_handle
;
198 struct radeon_winsys_cs_handle
;
199 struct radeon_winsys_ctx
;
201 struct radeon_winsys_cs
{
202 unsigned cdw
; /* Number of used dwords. */
203 unsigned max_dw
; /* Maximum number of dwords. */
204 uint32_t *buf
; /* The command buffer. */
205 enum ring_type ring_type
;
210 enum radeon_family family
;
211 enum chip_class chip_class
;
215 uint32_t max_compute_units
;
217 uint32_t max_sh_per_se
;
219 uint32_t drm_major
; /* version */
221 uint32_t drm_patchlevel
;
224 uint32_t vce_fw_version
;
227 uint32_t r300_num_gb_pipes
;
228 uint32_t r300_num_z_pipes
;
230 uint32_t r600_num_backends
;
231 uint32_t r600_clock_crystal_freq
;
232 uint32_t r600_tiling_config
;
233 uint32_t r600_num_tile_pipes
;
234 uint32_t r600_max_pipes
;
235 boolean r600_virtual_address
;
236 boolean r600_has_dma
;
238 uint32_t r600_backend_map
;
239 boolean r600_backend_map_valid
;
241 boolean si_tile_mode_array_valid
;
242 uint32_t si_tile_mode_array
[32];
243 uint32_t si_backend_enabled_mask
;
245 boolean cik_macrotile_mode_array_valid
;
246 uint32_t cik_macrotile_mode_array
[16];
249 enum radeon_feature_id
{
250 RADEON_FID_R300_HYPERZ_ACCESS
, /* ZMask + HiZ */
251 RADEON_FID_R300_CMASK_ACCESS
,
254 #define RADEON_SURF_MAX_LEVEL 32
256 #define RADEON_SURF_TYPE_MASK 0xFF
257 #define RADEON_SURF_TYPE_SHIFT 0
258 #define RADEON_SURF_TYPE_1D 0
259 #define RADEON_SURF_TYPE_2D 1
260 #define RADEON_SURF_TYPE_3D 2
261 #define RADEON_SURF_TYPE_CUBEMAP 3
262 #define RADEON_SURF_TYPE_1D_ARRAY 4
263 #define RADEON_SURF_TYPE_2D_ARRAY 5
264 #define RADEON_SURF_MODE_MASK 0xFF
265 #define RADEON_SURF_MODE_SHIFT 8
266 #define RADEON_SURF_MODE_LINEAR 0
267 #define RADEON_SURF_MODE_LINEAR_ALIGNED 1
268 #define RADEON_SURF_MODE_1D 2
269 #define RADEON_SURF_MODE_2D 3
270 #define RADEON_SURF_SCANOUT (1 << 16)
271 #define RADEON_SURF_ZBUFFER (1 << 17)
272 #define RADEON_SURF_SBUFFER (1 << 18)
273 #define RADEON_SURF_Z_OR_SBUFFER (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
274 #define RADEON_SURF_HAS_SBUFFER_MIPTREE (1 << 19)
275 #define RADEON_SURF_HAS_TILE_MODE_INDEX (1 << 20)
276 #define RADEON_SURF_FMASK (1 << 21)
278 #define RADEON_SURF_GET(v, field) (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
279 #define RADEON_SURF_SET(v, field) (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
280 #define RADEON_SURF_CLR(v, field) ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
282 struct radeon_surf_level
{
291 uint32_t pitch_bytes
;
296 /* These are inputs to the calculator. */
309 /* These are return values. Some of them can be set by the caller, but
310 * they will be treated as hints (e.g. bankw, bankh) and might be
311 * changed by the calculator.
314 uint64_t bo_alignment
;
315 /* This applies to EG and later. */
320 uint32_t stencil_tile_split
;
321 uint64_t stencil_offset
;
322 struct radeon_surf_level level
[RADEON_SURF_MAX_LEVEL
];
323 struct radeon_surf_level stencil_level
[RADEON_SURF_MAX_LEVEL
];
324 uint32_t tiling_index
[RADEON_SURF_MAX_LEVEL
];
325 uint32_t stencil_tiling_index
[RADEON_SURF_MAX_LEVEL
];
326 uint32_t pipe_config
;
330 struct radeon_winsys
{
332 * The screen object this winsys was created for
334 struct pipe_screen
*screen
;
337 * Decrement the winsys reference count.
339 * \param ws The winsys this function is called for.
340 * \return True if the winsys and screen should be destroyed.
342 bool (*unref
)(struct radeon_winsys
*ws
);
345 * Destroy this winsys.
347 * \param ws The winsys this function is called from.
349 void (*destroy
)(struct radeon_winsys
*ws
);
352 * Query an info structure from winsys.
354 * \param ws The winsys this function is called from.
355 * \param info Return structure
357 void (*query_info
)(struct radeon_winsys
*ws
,
358 struct radeon_info
*info
);
360 /**************************************************************************
361 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
363 * Remember that gallium gets to choose the interface it needs, and the
364 * window systems must then implement that interface (rather than the
365 * other way around...).
366 *************************************************************************/
369 * Create a buffer object.
371 * \param ws The winsys this function is called from.
372 * \param size The size to allocate.
373 * \param alignment An alignment of the buffer in memory.
374 * \param use_reusable_pool Whether the cache buffer manager should be used.
375 * \param domain A bitmask of the RADEON_DOMAIN_* flags.
376 * \return The created buffer object.
378 struct pb_buffer
*(*buffer_create
)(struct radeon_winsys
*ws
,
381 boolean use_reusable_pool
,
382 enum radeon_bo_domain domain
,
383 enum radeon_bo_flag flags
);
385 struct radeon_winsys_cs_handle
*(*buffer_get_cs_handle
)(
386 struct pb_buffer
*buf
);
389 * Map the entire data store of a buffer object into the client's address
392 * \param buf A winsys buffer object to map.
393 * \param cs A command stream to flush if the buffer is referenced by it.
394 * \param usage A bitmask of the PIPE_TRANSFER_* flags.
395 * \return The pointer at the beginning of the buffer.
397 void *(*buffer_map
)(struct radeon_winsys_cs_handle
*buf
,
398 struct radeon_winsys_cs
*cs
,
399 enum pipe_transfer_usage usage
);
402 * Unmap a buffer object from the client's address space.
404 * \param buf A winsys buffer object to unmap.
406 void (*buffer_unmap
)(struct radeon_winsys_cs_handle
*buf
);
409 * Wait for the buffer and return true if the buffer is not used
412 * The timeout of 0 will only return the status.
413 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
416 bool (*buffer_wait
)(struct pb_buffer
*buf
, uint64_t timeout
,
417 enum radeon_bo_usage usage
);
420 * Return tiling flags describing a memory layout of a buffer object.
422 * \param buf A winsys buffer object to get the flags from.
423 * \param macrotile A pointer to the return value of the microtile flag.
424 * \param microtile A pointer to the return value of the macrotile flag.
426 * \note microtile and macrotile are not bitmasks!
428 void (*buffer_get_tiling
)(struct pb_buffer
*buf
,
429 enum radeon_bo_layout
*microtile
,
430 enum radeon_bo_layout
*macrotile
,
431 unsigned *bankw
, unsigned *bankh
,
432 unsigned *tile_split
,
433 unsigned *stencil_tile_split
,
438 * Set tiling flags describing a memory layout of a buffer object.
440 * \param buf A winsys buffer object to set the flags for.
441 * \param cs A command stream to flush if the buffer is referenced by it.
442 * \param macrotile A macrotile flag.
443 * \param microtile A microtile flag.
444 * \param stride A stride of the buffer in bytes, for texturing.
446 * \note microtile and macrotile are not bitmasks!
448 void (*buffer_set_tiling
)(struct pb_buffer
*buf
,
449 struct radeon_winsys_cs
*rcs
,
450 enum radeon_bo_layout microtile
,
451 enum radeon_bo_layout macrotile
,
452 unsigned pipe_config
,
453 unsigned bankw
, unsigned bankh
,
455 unsigned stencil_tile_split
,
456 unsigned mtilea
, unsigned num_banks
,
461 * Get a winsys buffer from a winsys handle. The internal structure
462 * of the handle is platform-specific and only a winsys should access it.
464 * \param ws The winsys this function is called from.
465 * \param whandle A winsys handle pointer as was received from a state
467 * \param stride The returned buffer stride in bytes.
469 struct pb_buffer
*(*buffer_from_handle
)(struct radeon_winsys
*ws
,
470 struct winsys_handle
*whandle
,
474 * Get a winsys buffer from a user pointer. The resulting buffer can't
475 * be exported. Both pointer and size must be page aligned.
477 * \param ws The winsys this function is called from.
478 * \param pointer User pointer to turn into a buffer object.
479 * \param Size Size in bytes for the new buffer.
481 struct pb_buffer
*(*buffer_from_ptr
)(struct radeon_winsys
*ws
,
482 void *pointer
, unsigned size
);
485 * Get a winsys handle from a winsys buffer. The internal structure
486 * of the handle is platform-specific and only a winsys should access it.
488 * \param buf A winsys buffer object to get the handle from.
489 * \param whandle A winsys handle pointer.
490 * \param stride A stride of the buffer in bytes, for texturing.
491 * \return TRUE on success.
493 boolean (*buffer_get_handle
)(struct pb_buffer
*buf
,
495 struct winsys_handle
*whandle
);
498 * Return the virtual address of a buffer.
500 * \param buf A winsys buffer object
501 * \return virtual address
503 uint64_t (*buffer_get_virtual_address
)(struct radeon_winsys_cs_handle
*buf
);
506 * Query the initial placement of the buffer from the kernel driver.
508 enum radeon_bo_domain (*buffer_get_initial_domain
)(struct radeon_winsys_cs_handle
*buf
);
510 /**************************************************************************
511 * Command submission.
513 * Each pipe context should create its own command stream and submit
514 * commands independently of other contexts.
515 *************************************************************************/
518 * Create a command submission context.
519 * Various command streams can be submitted to the same context.
521 struct radeon_winsys_ctx
*(*ctx_create
)(struct radeon_winsys
*ws
);
526 void (*ctx_destroy
)(struct radeon_winsys_ctx
*ctx
);
529 * Query a GPU reset status.
531 enum pipe_reset_status (*ctx_query_reset_status
)(struct radeon_winsys_ctx
*ctx
);
534 * Create a command stream.
536 * \param ctx The submission context
537 * \param ring_type The ring type (GFX, DMA, UVD)
538 * \param flush Flush callback function associated with the command stream.
539 * \param user User pointer that will be passed to the flush callback.
540 * \param trace_buf Trace buffer when tracing is enabled
542 struct radeon_winsys_cs
*(*cs_create
)(struct radeon_winsys_ctx
*ctx
,
543 enum ring_type ring_type
,
544 void (*flush
)(void *ctx
, unsigned flags
,
545 struct pipe_fence_handle
**fence
),
547 struct radeon_winsys_cs_handle
*trace_buf
);
550 * Destroy a command stream.
552 * \param cs A command stream to destroy.
554 void (*cs_destroy
)(struct radeon_winsys_cs
*cs
);
557 * Add a new buffer relocation. Every relocation must first be added
558 * before it can be written.
560 * \param cs A command stream to add buffer for validation against.
561 * \param buf A winsys buffer to validate.
562 * \param usage Whether the buffer is used for read and/or write.
563 * \param domain Bitmask of the RADEON_DOMAIN_* flags.
564 * \param priority A higher number means a greater chance of being
565 * placed in the requested domain. 15 is the maximum.
566 * \return Relocation index.
568 unsigned (*cs_add_reloc
)(struct radeon_winsys_cs
*cs
,
569 struct radeon_winsys_cs_handle
*buf
,
570 enum radeon_bo_usage usage
,
571 enum radeon_bo_domain domain
,
572 enum radeon_bo_priority priority
);
575 * Return the index of an already-added buffer.
577 * \param cs Command stream
579 * \return The buffer index, or -1 if the buffer has not been added.
581 int (*cs_get_reloc
)(struct radeon_winsys_cs
*cs
,
582 struct radeon_winsys_cs_handle
*buf
);
585 * Return TRUE if there is enough memory in VRAM and GTT for the relocs
586 * added so far. If the validation fails, all the relocations which have
587 * been added since the last call of cs_validate will be removed and
588 * the CS will be flushed (provided there are still any relocations).
590 * \param cs A command stream to validate.
592 boolean (*cs_validate
)(struct radeon_winsys_cs
*cs
);
595 * Return TRUE if there is enough memory in VRAM and GTT for the relocs
598 * \param cs A command stream to validate.
599 * \param vram VRAM memory size pending to be use
600 * \param gtt GTT memory size pending to be use
602 boolean (*cs_memory_below_limit
)(struct radeon_winsys_cs
*cs
, uint64_t vram
, uint64_t gtt
);
605 * Flush a command stream.
607 * \param cs A command stream to flush.
608 * \param flags, RADEON_FLUSH_ASYNC or 0.
609 * \param fence Pointer to a fence. If non-NULL, a fence is inserted
610 * after the CS and is returned through this parameter.
611 * \param cs_trace_id A unique identifier of the cs, used for tracing.
613 void (*cs_flush
)(struct radeon_winsys_cs
*cs
,
615 struct pipe_fence_handle
**fence
,
616 uint32_t cs_trace_id
);
619 * Return TRUE if a buffer is referenced by a command stream.
621 * \param cs A command stream.
622 * \param buf A winsys buffer.
624 boolean (*cs_is_buffer_referenced
)(struct radeon_winsys_cs
*cs
,
625 struct radeon_winsys_cs_handle
*buf
,
626 enum radeon_bo_usage usage
);
629 * Request access to a feature for a command stream.
631 * \param cs A command stream.
632 * \param fid Feature ID, one of RADEON_FID_*
633 * \param enable Whether to enable or disable the feature.
635 boolean (*cs_request_feature
)(struct radeon_winsys_cs
*cs
,
636 enum radeon_feature_id fid
,
639 * Make sure all asynchronous flush of the cs have completed
641 * \param cs A command stream.
643 void (*cs_sync_flush
)(struct radeon_winsys_cs
*cs
);
646 * Wait for the fence and return true if the fence has been signalled.
647 * The timeout of 0 will only return the status.
648 * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
651 bool (*fence_wait
)(struct radeon_winsys
*ws
,
652 struct pipe_fence_handle
*fence
,
656 * Reference counting for fences.
658 void (*fence_reference
)(struct pipe_fence_handle
**dst
,
659 struct pipe_fence_handle
*src
);
664 * \param ws The winsys this function is called from.
665 * \param surf Surface structure ptr
667 int (*surface_init
)(struct radeon_winsys
*ws
,
668 struct radeon_surf
*surf
);
671 * Find best values for a surface
673 * \param ws The winsys this function is called from.
674 * \param surf Surface structure ptr
676 int (*surface_best
)(struct radeon_winsys
*ws
,
677 struct radeon_surf
*surf
);
679 uint64_t (*query_value
)(struct radeon_winsys
*ws
,
680 enum radeon_value_id value
);
682 void (*read_registers
)(struct radeon_winsys
*ws
, unsigned reg_offset
,
683 unsigned num_registers
, uint32_t *out
);
687 static inline void radeon_emit(struct radeon_winsys_cs
*cs
, uint32_t value
)
689 cs
->buf
[cs
->cdw
++] = value
;
692 static inline void radeon_emit_array(struct radeon_winsys_cs
*cs
,
693 const uint32_t *values
, unsigned count
)
695 memcpy(cs
->buf
+cs
->cdw
, values
, count
* 4);