2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE. */
23 #ifndef R300_CONTEXT_H
24 #define R300_CONTEXT_H
26 #include "draw/draw_vertex.h"
28 #include "util/u_blitter.h"
30 #include "pipe/p_context.h"
31 #include "util/u_inlines.h"
32 #include "util/u_transfer.h"
33 #include "util/u_vbuf_mgr.h"
35 #include "r300_defines.h"
36 #include "r300_screen.h"
37 #include "r300_winsys.h"
41 struct r300_fragment_shader;
42 struct r300_vertex_shader;
43 struct r300_stencilref_context;
46 /* Name, for debugging. */
50 /* Emit the state to the context. */
51 void (*emit)(struct r300_context*, unsigned, void*);
52 /* Upper bound on number of dwords to emit. */
54 /* Whether this atom should be emitted. */
56 /* Whether this atom may be emitted with state == NULL. */
57 boolean allow_null_state;
60 struct r300_aa_state {
61 struct r300_surface *dest;
64 uint32_t aaresolve_ctl;
67 struct r300_blend_state {
69 uint32_t cb_no_readwrite[8];
72 struct r300_blend_color_state {
76 struct r300_clip_state {
77 struct pipe_clip_state clip;
82 struct r300_dsa_state {
83 struct pipe_depth_stencil_alpha_state dsa;
85 /* This is actually a command buffer with named dwords. */
87 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
89 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
90 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
91 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
93 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
95 /* The second command buffer disables zbuffer reads and writes. */
96 uint32_t cb_no_readwrite[8];
98 /* Whether a two-sided stencil is enabled. */
100 /* Whether a fallback should be used for a two-sided stencil ref value. */
101 boolean two_sided_stencil_ref;
104 struct r300_hyperz_state {
106 /* This is actually a command buffer with named dwords. */
107 uint32_t cb_flush_begin;
108 uint32_t zb_zcache_ctlstat; /* R300_ZB_CACHE_CNTL */
110 uint32_t zb_bw_cntl; /* R300_ZB_BW_CNTL */
112 uint32_t zb_depthclearvalue; /* R300_ZB_DEPTHCLEARVALUE */
114 uint32_t sc_hyperz; /* R300_SC_HYPERZ */
116 uint32_t gb_z_peq_config; /* R300_GB_Z_PEQ_CONFIG: 0x4028 */
119 struct r300_gpu_flush {
120 uint32_t cb_flush_clean[6];
123 #define RS_STATE_MAIN_SIZE 23
125 struct r300_rs_state {
126 /* Original rasterizer state. */
127 struct pipe_rasterizer_state rs;
128 /* Draw-specific rasterizer state. */
129 struct pipe_rasterizer_state rs_draw;
131 /* Command buffers. */
132 uint32_t cb_main[RS_STATE_MAIN_SIZE];
133 uint32_t cb_poly_offset_zb16[5];
134 uint32_t cb_poly_offset_zb24[5];
136 /* The index to cb_main where the cull_mode register value resides. */
137 unsigned cull_mode_index;
139 /* Whether polygon offset is enabled. */
140 boolean polygon_offset_enable;
142 /* This is emitted in the draw function. */
143 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
146 struct r300_rs_block {
147 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
148 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
149 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
152 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
153 uint32_t count; /* R300_RS_COUNT */
154 uint32_t inst_count; /* R300_RS_INST_COUNT */
155 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
158 struct r300_sampler_state {
159 struct pipe_sampler_state state;
161 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
162 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
164 /* Min/max LOD must be clamped to [0, last_level], thus
165 * it's dependent on a currently bound texture */
166 unsigned min_lod, max_lod;
169 struct r300_texture_format_state {
170 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
171 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
172 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
173 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
176 struct r300_sampler_view {
177 struct pipe_sampler_view base;
179 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
180 * derived from base. */
181 unsigned char swizzle[4];
183 /* Copy of r300_texture::texture_format_state with format-specific bits
185 struct r300_texture_format_state format;
187 /* The texture cache region for this texture. */
188 uint32_t texcache_region;
191 struct r300_texture_sampler_state {
192 struct r300_texture_format_state format;
193 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
194 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
195 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
198 struct r300_textures_state {
200 struct r300_sampler_view *sampler_views[16];
201 int sampler_view_count;
202 /* Sampler states. */
203 struct r300_sampler_state *sampler_states[16];
204 int sampler_state_count;
206 /* This is the merge of the texture and sampler states. */
208 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
209 struct r300_texture_sampler_state regs[16];
212 struct r300_vertex_stream_state {
213 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
214 uint32_t vap_prog_stream_cntl[8];
215 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
216 uint32_t vap_prog_stream_cntl_ext[8];
221 struct r300_invariant_state {
225 struct r300_vap_invariant_state {
229 struct r300_viewport_state {
230 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
231 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
232 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
233 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
234 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
235 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
236 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
239 struct r300_ztop_state {
240 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
243 /* The next several objects are not pure Radeon state; they inherit from
244 * various Gallium classes. */
246 struct r300_constant_buffer {
247 /* Buffer of constants */
249 /* Remapping table. */
250 unsigned *remap_table;
251 /* const buffer base */
252 uint32_t buffer_base;
257 * This is not a subclass of pipe_query because pipe_query is never
258 * actually fully defined. So, rather than have it as a member, and do
259 * subclass-style casting, we treat pipe_query as an opaque, and just
260 * trust that our state tracker does not ever mess up query objects.
263 /* The kind of query. Currently only OQ is supported. */
265 /* The number of pipes where query results are stored. */
267 /* How many results have been written, in dwords. It's incremented
268 * after end_query and flush. */
269 unsigned num_results;
270 /* if begin has been emitted */
271 boolean begin_emitted;
273 /* The buffer where query results are stored. */
274 struct r300_winsys_bo *buf;
275 struct r300_winsys_cs_handle *cs_buf;
276 /* The size of the buffer. */
277 unsigned buffer_size;
278 /* The domain of the buffer. */
279 enum r300_buffer_domain domain;
281 /* Linked list members. */
282 struct r300_query* prev;
283 struct r300_query* next;
286 struct r300_surface {
287 struct pipe_surface base;
289 /* Winsys buffer backing the texture. */
290 struct r300_winsys_bo *buf;
291 struct r300_winsys_cs_handle *cs_buf;
293 enum r300_buffer_domain domain;
295 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
296 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
297 uint32_t pitch_zmask; /* ZMASK_PITCH */
298 uint32_t pitch_hiz; /* HIZ_PITCH */
299 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
301 /* Parameters dedicated to the CBZB clear. */
302 uint32_t cbzb_width; /* Aligned width. */
303 uint32_t cbzb_height; /* Half of the height. */
304 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
305 uint32_t cbzb_pitch; /* DEPTHPITCH. */
306 uint32_t cbzb_format; /* ZB_FORMAT. */
308 /* Whether the CBZB clear is allowed on the surface. */
309 boolean cbzb_allowed;
312 struct r300_texture_desc {
313 /* Width, height, and depth.
314 * Most of the time, these are equal to pipe_texture::width0, height0,
315 * and depth0. However, NPOT 3D textures must have dimensions aligned
316 * to POT, and this is the only case when these variables differ from
318 unsigned width0, height0, depth0;
321 * Macrotiling is specified per-level because small mipmaps cannot
323 enum r300_buffer_tiling microtile;
324 enum r300_buffer_tiling macrotile[R300_MAX_TEXTURE_LEVELS];
326 /* Offsets into the buffer. */
327 unsigned offset_in_bytes[R300_MAX_TEXTURE_LEVELS];
329 /* Strides for each mip-level. */
330 unsigned stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
331 unsigned stride_in_bytes[R300_MAX_TEXTURE_LEVELS];
333 /* Size of one zslice or face or 2D image based on the texture target. */
334 unsigned layer_size_in_bytes[R300_MAX_TEXTURE_LEVELS];
336 /* Total size of this texture, in bytes,
337 * derived from the texture properties. */
338 unsigned size_in_bytes;
340 /* Total size of the buffer backing this texture, in bytes.
341 * It must be >= size. */
342 unsigned buffer_size_in_bytes;
345 * If non-zero, override the natural texture layout with
346 * a custom stride (in bytes).
348 * \note Mipmapping fails for textures with a non-natural layout!
350 * \sa r300_texture_get_stride
352 unsigned stride_in_bytes_override;
354 /* Whether this texture has non-power-of-two dimensions.
355 * It can be either a regular texture or a rectangle one. */
358 /* This flag says that hardware must use the stride for addressing
359 * instead of the width. */
360 boolean uses_stride_addressing;
362 /* Whether CBZB fast color clear is allowed on the miplevel. */
363 boolean cbzb_allowed[R300_MAX_TEXTURE_LEVELS];
365 /* Zbuffer compression info for each miplevel. */
366 boolean zcomp8x8[R300_MAX_TEXTURE_LEVELS];
367 /* If zero, then disable Z compression/HiZ. */
368 unsigned zmask_dwords[R300_MAX_TEXTURE_LEVELS];
369 unsigned hiz_dwords[R300_MAX_TEXTURE_LEVELS];
370 /* Zmask/HiZ strides for each miplevel. */
371 unsigned zmask_stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
372 unsigned hiz_stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
377 struct u_vbuf_resource b;
379 /* Winsys buffer backing this resource. */
380 struct r300_winsys_bo *buf;
381 struct r300_winsys_cs_handle *cs_buf;
382 enum r300_buffer_domain domain;
385 /* Constant buffers are in user memory. */
386 uint8_t *constant_buffer;
388 /* Texture description (addressing, layout, special features). */
389 struct r300_texture_desc tex;
391 /* Registers carrying texture format data. */
392 /* Only format-independent bits should be filled in. */
393 struct r300_texture_format_state tx_format;
395 /* Where the texture starts in the buffer. */
398 /* This is the level tiling flags were last time set for.
399 * It's used to prevent redundant tiling-flags changes from happening.*/
400 unsigned surface_level;
403 struct r300_vertex_element_state {
405 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
406 unsigned format_size[PIPE_MAX_ATTRIBS];
408 struct u_vbuf_mgr_elements *vmgr_elements;
410 /* The size of the vertex, in dwords. */
411 unsigned vertex_size_dwords;
413 struct r300_vertex_stream_state vertex_stream;
419 /* The function, when determined, is set in stone
420 * until the next HiZ clear. */
422 /* MAX is written to the HiZ buffer.
423 * Used for LESS, LEQUAL. */
426 /* MIN is written to the HiZ buffer.
427 * Used for GREATER, GEQUAL. */
431 struct r300_context {
433 struct pipe_context context;
435 /* The interface to the windowing system, etc. */
436 struct r300_winsys_screen *rws;
437 /* The command stream. */
438 struct r300_winsys_cs *cs;
440 struct r300_screen *screen;
442 /* Draw module. Used mostly for SW TCL. */
443 struct draw_context* draw;
444 /* Vertex buffer for SW TCL. */
445 struct pipe_resource* vbo;
446 /* Offset and size into the SW TCL VBO. */
447 size_t draw_vbo_offset;
448 size_t draw_vbo_size;
449 /* Whether the VBO must not be flushed. */
450 boolean draw_vbo_locked;
451 boolean draw_first_emitted;
453 /* Accelerated blit support. */
454 struct blitter_context* blitter;
455 /* Stencil two-sided reference value fallback. */
456 struct r300_stencilref_context *stencilref_fallback;
458 /* The KIL opcode needs the first texture unit to be enabled
459 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
460 * dummy texture there. */
461 struct r300_sampler_view *texkill_sampler;
463 /* When no vertex buffer is set, this one is used instead to prevent
465 struct pipe_resource *dummy_vb;
467 /* The currently active query. */
468 struct r300_query *query_current;
469 /* The saved query for blitter operations. */
470 struct r300_query *blitter_saved_query;
472 struct r300_query query_list;
474 /* Various CSO state objects. */
476 /* Each atom is emitted in the order it appears here, which can affect
477 * performance and stability if not handled with care. */
479 struct r300_atom gpu_flush;
480 /* Anti-aliasing (MSAA) state. */
481 struct r300_atom aa_state;
482 /* Framebuffer state. */
483 struct r300_atom fb_state;
484 /* HyperZ state (various SC/ZB bits). */
485 struct r300_atom hyperz_state;
487 struct r300_atom ztop_state;
488 /* Depth, stencil, and alpha state. */
489 struct r300_atom dsa_state;
491 struct r300_atom blend_state;
492 /* Blend color state. */
493 struct r300_atom blend_color_state;
495 struct r300_atom scissor_state;
496 /* Invariant state. This must be emitted to get the engine started. */
497 struct r300_atom invariant_state;
498 /* Viewport state. */
499 struct r300_atom viewport_state;
501 struct r300_atom pvs_flush;
502 /* VAP invariant state. */
503 struct r300_atom vap_invariant_state;
504 /* Vertex stream formatting state. */
505 struct r300_atom vertex_stream_state;
507 struct r300_atom vs_state;
508 /* User clip planes. */
509 struct r300_atom clip_state;
510 /* RS block state + VAP (vertex shader) output mapping state. */
511 struct r300_atom rs_block_state;
512 /* Rasterizer state. */
513 struct r300_atom rs_state;
514 /* Framebuffer state (pipelined regs). */
515 struct r300_atom fb_state_pipelined;
516 /* Fragment shader. */
518 /* Fragment shader RC_CONSTANT_STATE variables. */
519 struct r300_atom fs_rc_constant_state;
520 /* Fragment shader constant buffer. */
521 struct r300_atom fs_constants;
522 /* Vertex shader constant buffer. */
523 struct r300_atom vs_constants;
524 /* Texture cache invalidate. */
525 struct r300_atom texture_cache_inval;
526 /* Textures state. */
527 struct r300_atom textures_state;
529 struct r300_atom hiz_clear;
531 struct r300_atom zmask_clear;
532 /* Occlusion query. */
533 struct r300_atom query_start;
535 /* The pointers to the first and the last atom. */
536 struct r300_atom *first_dirty, *last_dirty;
538 /* Vertex elements for Gallium. */
539 struct r300_vertex_element_state *velems;
541 struct pipe_index_buffer index_buffer;
543 /* Vertex info for Draw. */
544 struct vertex_info vertex_info;
546 struct pipe_stencil_ref stencil_ref;
547 struct pipe_viewport_state viewport;
549 /* Stream locations for SWTCL. */
550 int stream_loc_notcl[16];
552 /* Flag indicating whether or not the HW is dirty. */
554 /* Whether polygon offset is enabled. */
555 boolean polygon_offset_enabled;
556 /* Z buffer bit depth. */
557 uint32_t zbuffer_bpp;
558 /* Whether rendering is conditional and should be skipped. */
559 boolean skip_rendering;
560 /* Point sprites texcoord index, 1 bit per texcoord */
561 int sprite_coord_enable;
562 /* Whether two-sided color selection is enabled (AKA light_twoside). */
563 boolean two_sided_color;
564 /* Whether fast color clear is enabled. */
566 /* Whether ZMASK is enabled. */
567 boolean zmask_in_use;
568 /* Whether ZMASK is being decompressed. */
569 boolean zmask_decompress;
570 /* Whether ZMASK/HIZ is locked, i.e. should be disabled and cannot be taken over. */
571 boolean hyperz_locked;
572 /* The zbuffer the ZMASK of which is locked. */
573 struct pipe_surface *locked_zbuffer;
574 /* Whether HIZ is enabled. */
576 /* HiZ function. Can be either MIN or MAX. */
577 enum r300_hiz_func hiz_func;
578 /* HiZ clear value. */
579 uint32_t hiz_clear_value;
581 void *dsa_decompress_zmask;
583 struct u_vbuf_mgr *vbuf_mgr;
585 struct util_slab_mempool pool_transfers;
588 uint64_t flush_counter;
590 /* const tracking for VS */
593 /* Vertex array state info */
594 boolean vertex_arrays_dirty;
595 boolean vertex_arrays_indexed;
596 int vertex_arrays_offset;
599 #define foreach_atom(r300, atom) \
600 for (atom = &r300->gpu_flush; atom != (&r300->query_start)+1; atom++)
602 #define foreach_dirty_atom(r300, atom) \
603 for (atom = r300->first_dirty; atom != r300->last_dirty; atom++)
605 /* Convenience cast wrappers. */
606 static INLINE struct r300_query* r300_query(struct pipe_query* q)
608 return (struct r300_query*)q;
611 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
613 return (struct r300_surface*)surf;
616 static INLINE struct r300_resource* r300_resource(struct pipe_resource* tex)
618 return (struct r300_resource*)tex;
621 static INLINE struct r300_context* r300_context(struct pipe_context* context)
623 return (struct r300_context*)context;
626 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
628 return (struct r300_fragment_shader*)r300->fs.state;
631 static INLINE void r300_mark_atom_dirty(struct r300_context *r300,
632 struct r300_atom *atom)
636 if (!r300->first_dirty) {
637 r300->first_dirty = atom;
638 r300->last_dirty = atom+1;
640 if (atom < r300->first_dirty)
641 r300->first_dirty = atom;
642 else if (atom+1 > r300->last_dirty)
643 r300->last_dirty = atom+1;
647 struct pipe_context* r300_create_context(struct pipe_screen* screen,
650 void r300_flush_cb(void *data);
652 /* Context initialization. */
653 struct draw_stage* r300_draw_stage(struct r300_context* r300);
654 void r300_init_blit_functions(struct r300_context *r300);
655 void r300_init_flush_functions(struct r300_context* r300);
656 void r300_init_query_functions(struct r300_context* r300);
657 void r300_init_render_functions(struct r300_context *r300);
658 void r300_init_state_functions(struct r300_context* r300);
659 void r300_init_resource_functions(struct r300_context* r300);
662 void r300_decompress_zmask(struct r300_context *r300);
663 void r300_decompress_zmask_locked_unsafe(struct r300_context *r300);
664 void r300_decompress_zmask_locked(struct r300_context *r300);
667 void r300_update_hyperz_state(struct r300_context* r300);
670 void r300_resume_query(struct r300_context *r300,
671 struct r300_query *query);
672 void r300_stop_query(struct r300_context *r300);
674 /* r300_render_translate.c */
675 void r300_translate_index_buffer(struct r300_context *r300,
676 struct pipe_resource **index_buffer,
677 unsigned *index_size, unsigned index_offset,
678 unsigned *start, unsigned count);
680 /* r300_render_stencilref.c */
681 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
684 void r300_draw_flush_vbuf(struct r300_context *r300);
685 void r500_emit_index_bias(struct r300_context *r300, int index_bias);
688 enum r300_fb_state_change {
689 R300_CHANGED_FB_STATE = 0,
690 R300_CHANGED_HYPERZ_FLAG,
691 R300_CHANGED_MULTIWRITE
694 void r300_mark_fb_state_dirty(struct r300_context *r300,
695 enum r300_fb_state_change change);
696 void r300_mark_fs_code_dirty(struct r300_context *r300);
698 /* r300_state_derived.c */
699 void r300_update_derived_state(struct r300_context* r300);
702 void r500_dump_rs_block(struct r300_rs_block *rs);
705 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
707 return SCREEN_DBG_ON(ctx->screen, flags);
710 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
711 const char * fmt, ...)
713 if (CTX_DBG_ON(ctx, flags)) {
716 vfprintf(stderr, fmt, va);
721 #define DBG_ON CTX_DBG_ON
724 #endif /* R300_CONTEXT_H */