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 {
73 struct pipe_blend_color state;
77 struct r300_clip_state {
78 struct pipe_clip_state clip;
83 struct r300_dsa_state {
84 struct pipe_depth_stencil_alpha_state dsa;
86 /* This is actually a command buffer with named dwords. */
88 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
90 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
91 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
92 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
94 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
96 /* The second command buffer disables zbuffer reads and writes. */
97 uint32_t cb_no_readwrite[8];
99 /* Whether a two-sided stencil is enabled. */
101 /* Whether a fallback should be used for a two-sided stencil ref value. */
102 boolean two_sided_stencil_ref;
105 struct r300_hyperz_state {
107 /* This is actually a command buffer with named dwords. */
108 uint32_t cb_flush_begin;
109 uint32_t zb_zcache_ctlstat; /* R300_ZB_CACHE_CNTL */
111 uint32_t zb_bw_cntl; /* R300_ZB_BW_CNTL */
113 uint32_t zb_depthclearvalue; /* R300_ZB_DEPTHCLEARVALUE */
115 uint32_t sc_hyperz; /* R300_SC_HYPERZ */
117 uint32_t gb_z_peq_config; /* R300_GB_Z_PEQ_CONFIG: 0x4028 */
120 struct r300_gpu_flush {
121 uint32_t cb_flush_clean[6];
124 #define RS_STATE_MAIN_SIZE 23
126 struct r300_rs_state {
127 /* Original rasterizer state. */
128 struct pipe_rasterizer_state rs;
129 /* Draw-specific rasterizer state. */
130 struct pipe_rasterizer_state rs_draw;
132 /* Command buffers. */
133 uint32_t cb_main[RS_STATE_MAIN_SIZE];
134 uint32_t cb_poly_offset_zb16[5];
135 uint32_t cb_poly_offset_zb24[5];
137 /* The index to cb_main where the cull_mode register value resides. */
138 unsigned cull_mode_index;
140 /* Whether polygon offset is enabled. */
141 boolean polygon_offset_enable;
143 /* This is emitted in the draw function. */
144 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
147 struct r300_rs_block {
148 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
149 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
150 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
153 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
154 uint32_t count; /* R300_RS_COUNT */
155 uint32_t inst_count; /* R300_RS_INST_COUNT */
156 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
159 struct r300_sampler_state {
160 struct pipe_sampler_state state;
162 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
163 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
165 /* Min/max LOD must be clamped to [0, last_level], thus
166 * it's dependent on a currently bound texture */
167 unsigned min_lod, max_lod;
170 struct r300_texture_format_state {
171 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
172 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
173 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
174 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
177 struct r300_sampler_view {
178 struct pipe_sampler_view base;
180 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
181 * derived from base. */
182 unsigned char swizzle[4];
184 /* Copy of r300_texture::texture_format_state with format-specific bits
186 struct r300_texture_format_state format;
188 /* The texture cache region for this texture. */
189 uint32_t texcache_region;
192 struct r300_texture_sampler_state {
193 struct r300_texture_format_state format;
194 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
195 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
196 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
199 struct r300_textures_state {
201 struct r300_sampler_view *sampler_views[16];
202 int sampler_view_count;
203 /* Sampler states. */
204 struct r300_sampler_state *sampler_states[16];
205 int sampler_state_count;
207 /* This is the merge of the texture and sampler states. */
209 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
210 struct r300_texture_sampler_state regs[16];
213 struct r300_vertex_stream_state {
214 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
215 uint32_t vap_prog_stream_cntl[8];
216 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
217 uint32_t vap_prog_stream_cntl_ext[8];
222 struct r300_invariant_state {
226 struct r300_vap_invariant_state {
230 struct r300_viewport_state {
231 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
232 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
233 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
234 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
235 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
236 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
237 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
240 struct r300_ztop_state {
241 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
244 /* The next several objects are not pure Radeon state; they inherit from
245 * various Gallium classes. */
247 struct r300_constant_buffer {
248 /* Buffer of constants */
250 /* Remapping table. */
251 unsigned *remap_table;
252 /* const buffer base */
253 uint32_t buffer_base;
258 * This is not a subclass of pipe_query because pipe_query is never
259 * actually fully defined. So, rather than have it as a member, and do
260 * subclass-style casting, we treat pipe_query as an opaque, and just
261 * trust that our state tracker does not ever mess up query objects.
264 /* The kind of query. Currently only OQ is supported. */
266 /* The number of pipes where query results are stored. */
268 /* How many results have been written, in dwords. It's incremented
269 * after end_query and flush. */
270 unsigned num_results;
271 /* if begin has been emitted */
272 boolean begin_emitted;
274 /* The buffer where query results are stored. */
275 struct r300_winsys_bo *buf;
276 struct r300_winsys_cs_handle *cs_buf;
277 /* The size of the buffer. */
278 unsigned buffer_size;
279 /* The domain of the buffer. */
280 enum r300_buffer_domain domain;
282 /* Linked list members. */
283 struct r300_query* prev;
284 struct r300_query* next;
287 struct r300_surface {
288 struct pipe_surface base;
290 /* Winsys buffer backing the texture. */
291 struct r300_winsys_bo *buf;
292 struct r300_winsys_cs_handle *cs_buf;
294 enum r300_buffer_domain domain;
296 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
297 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
298 uint32_t pitch_zmask; /* ZMASK_PITCH */
299 uint32_t pitch_hiz; /* HIZ_PITCH */
300 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
302 /* Parameters dedicated to the CBZB clear. */
303 uint32_t cbzb_width; /* Aligned width. */
304 uint32_t cbzb_height; /* Half of the height. */
305 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
306 uint32_t cbzb_pitch; /* DEPTHPITCH. */
307 uint32_t cbzb_format; /* ZB_FORMAT. */
309 /* Whether the CBZB clear is allowed on the surface. */
310 boolean cbzb_allowed;
313 struct r300_texture_desc {
314 /* Width, height, and depth.
315 * Most of the time, these are equal to pipe_texture::width0, height0,
316 * and depth0. However, NPOT 3D textures must have dimensions aligned
317 * to POT, and this is the only case when these variables differ from
319 unsigned width0, height0, depth0;
322 * Macrotiling is specified per-level because small mipmaps cannot
324 enum r300_buffer_tiling microtile;
325 enum r300_buffer_tiling macrotile[R300_MAX_TEXTURE_LEVELS];
327 /* Offsets into the buffer. */
328 unsigned offset_in_bytes[R300_MAX_TEXTURE_LEVELS];
330 /* Strides for each mip-level. */
331 unsigned stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
332 unsigned stride_in_bytes[R300_MAX_TEXTURE_LEVELS];
334 /* Size of one zslice or face or 2D image based on the texture target. */
335 unsigned layer_size_in_bytes[R300_MAX_TEXTURE_LEVELS];
337 /* Total size of this texture, in bytes,
338 * derived from the texture properties. */
339 unsigned size_in_bytes;
341 /* Total size of the buffer backing this texture, in bytes.
342 * It must be >= size. */
343 unsigned buffer_size_in_bytes;
346 * If non-zero, override the natural texture layout with
347 * a custom stride (in bytes).
349 * \note Mipmapping fails for textures with a non-natural layout!
351 * \sa r300_texture_get_stride
353 unsigned stride_in_bytes_override;
355 /* Whether this texture has non-power-of-two dimensions.
356 * It can be either a regular texture or a rectangle one. */
359 /* This flag says that hardware must use the stride for addressing
360 * instead of the width. */
361 boolean uses_stride_addressing;
363 /* Whether CBZB fast color clear is allowed on the miplevel. */
364 boolean cbzb_allowed[R300_MAX_TEXTURE_LEVELS];
366 /* Zbuffer compression info for each miplevel. */
367 boolean zcomp8x8[R300_MAX_TEXTURE_LEVELS];
368 /* If zero, then disable Z compression/HiZ. */
369 unsigned zmask_dwords[R300_MAX_TEXTURE_LEVELS];
370 unsigned hiz_dwords[R300_MAX_TEXTURE_LEVELS];
371 /* Zmask/HiZ strides for each miplevel. */
372 unsigned zmask_stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
373 unsigned hiz_stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
378 struct u_vbuf_resource b;
380 /* Winsys buffer backing this resource. */
381 struct r300_winsys_bo *buf;
382 struct r300_winsys_cs_handle *cs_buf;
383 enum r300_buffer_domain domain;
386 /* Constant buffers are in user memory. */
387 uint8_t *constant_buffer;
389 /* Texture description (addressing, layout, special features). */
390 struct r300_texture_desc tex;
392 /* Registers carrying texture format data. */
393 /* Only format-independent bits should be filled in. */
394 struct r300_texture_format_state tx_format;
396 /* Where the texture starts in the buffer. */
399 /* This is the level tiling flags were last time set for.
400 * It's used to prevent redundant tiling-flags changes from happening.*/
401 unsigned surface_level;
404 struct r300_vertex_element_state {
406 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
407 unsigned format_size[PIPE_MAX_ATTRIBS];
409 struct u_vbuf_mgr_elements *vmgr_elements;
411 /* The size of the vertex, in dwords. */
412 unsigned vertex_size_dwords;
414 struct r300_vertex_stream_state vertex_stream;
420 /* The function, when determined, is set in stone
421 * until the next HiZ clear. */
423 /* MAX is written to the HiZ buffer.
424 * Used for LESS, LEQUAL. */
427 /* MIN is written to the HiZ buffer.
428 * Used for GREATER, GEQUAL. */
432 struct r300_context {
434 struct pipe_context context;
436 /* The interface to the windowing system, etc. */
437 struct r300_winsys_screen *rws;
438 /* The command stream. */
439 struct r300_winsys_cs *cs;
441 struct r300_screen *screen;
443 /* Draw module. Used mostly for SW TCL. */
444 struct draw_context* draw;
445 /* Vertex buffer for SW TCL. */
446 struct pipe_resource* vbo;
447 /* Offset and size into the SW TCL VBO. */
448 size_t draw_vbo_offset;
449 size_t draw_vbo_size;
450 /* Whether the VBO must not be flushed. */
451 boolean draw_vbo_locked;
452 boolean draw_first_emitted;
454 /* Accelerated blit support. */
455 struct blitter_context* blitter;
456 /* Stencil two-sided reference value fallback. */
457 struct r300_stencilref_context *stencilref_fallback;
459 /* The KIL opcode needs the first texture unit to be enabled
460 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
461 * dummy texture there. */
462 struct r300_sampler_view *texkill_sampler;
464 /* When no vertex buffer is set, this one is used instead to prevent
466 struct pipe_resource *dummy_vb;
468 /* The currently active query. */
469 struct r300_query *query_current;
470 /* The saved query for blitter operations. */
471 struct r300_query *blitter_saved_query;
473 struct r300_query query_list;
475 /* Various CSO state objects. */
477 /* Each atom is emitted in the order it appears here, which can affect
478 * performance and stability if not handled with care. */
480 struct r300_atom gpu_flush;
481 /* Anti-aliasing (MSAA) state. */
482 struct r300_atom aa_state;
483 /* Framebuffer state. */
484 struct r300_atom fb_state;
485 /* HyperZ state (various SC/ZB bits). */
486 struct r300_atom hyperz_state;
488 struct r300_atom ztop_state;
489 /* Depth, stencil, and alpha state. */
490 struct r300_atom dsa_state;
492 struct r300_atom blend_state;
493 /* Blend color state. */
494 struct r300_atom blend_color_state;
496 struct r300_atom scissor_state;
497 /* Invariant state. This must be emitted to get the engine started. */
498 struct r300_atom invariant_state;
499 /* Viewport state. */
500 struct r300_atom viewport_state;
502 struct r300_atom pvs_flush;
503 /* VAP invariant state. */
504 struct r300_atom vap_invariant_state;
505 /* Vertex stream formatting state. */
506 struct r300_atom vertex_stream_state;
508 struct r300_atom vs_state;
509 /* User clip planes. */
510 struct r300_atom clip_state;
511 /* RS block state + VAP (vertex shader) output mapping state. */
512 struct r300_atom rs_block_state;
513 /* Rasterizer state. */
514 struct r300_atom rs_state;
515 /* Framebuffer state (pipelined regs). */
516 struct r300_atom fb_state_pipelined;
517 /* Fragment shader. */
519 /* Fragment shader RC_CONSTANT_STATE variables. */
520 struct r300_atom fs_rc_constant_state;
521 /* Fragment shader constant buffer. */
522 struct r300_atom fs_constants;
523 /* Vertex shader constant buffer. */
524 struct r300_atom vs_constants;
525 /* Texture cache invalidate. */
526 struct r300_atom texture_cache_inval;
527 /* Textures state. */
528 struct r300_atom textures_state;
530 struct r300_atom hiz_clear;
532 struct r300_atom zmask_clear;
533 /* Occlusion query. */
534 struct r300_atom query_start;
536 /* The pointers to the first and the last atom. */
537 struct r300_atom *first_dirty, *last_dirty;
539 /* Vertex elements for Gallium. */
540 struct r300_vertex_element_state *velems;
542 struct pipe_index_buffer index_buffer;
544 /* Vertex info for Draw. */
545 struct vertex_info vertex_info;
547 struct pipe_stencil_ref stencil_ref;
548 struct pipe_viewport_state viewport;
550 /* Stream locations for SWTCL. */
551 int stream_loc_notcl[16];
553 /* Flag indicating whether or not the HW is dirty. */
555 /* Whether polygon offset is enabled. */
556 boolean polygon_offset_enabled;
557 /* Z buffer bit depth. */
558 uint32_t zbuffer_bpp;
559 /* Whether rendering is conditional and should be skipped. */
560 boolean skip_rendering;
561 /* Point sprites texcoord index, 1 bit per texcoord */
562 int sprite_coord_enable;
563 /* Whether two-sided color selection is enabled (AKA light_twoside). */
564 boolean two_sided_color;
565 /* Whether fast color clear is enabled. */
567 /* Whether ZMASK is enabled. */
568 boolean zmask_in_use;
569 /* Whether ZMASK is being decompressed. */
570 boolean zmask_decompress;
571 /* Whether ZMASK/HIZ is locked, i.e. should be disabled and cannot be taken over. */
572 boolean hyperz_locked;
573 /* The zbuffer the ZMASK of which is locked. */
574 struct pipe_surface *locked_zbuffer;
575 /* Whether HIZ is enabled. */
577 /* HiZ function. Can be either MIN or MAX. */
578 enum r300_hiz_func hiz_func;
579 /* HiZ clear value. */
580 uint32_t hiz_clear_value;
582 void *dsa_decompress_zmask;
584 struct u_vbuf_mgr *vbuf_mgr;
586 struct util_slab_mempool pool_transfers;
589 uint64_t flush_counter;
591 /* const tracking for VS */
594 /* Vertex array state info */
595 boolean vertex_arrays_dirty;
596 boolean vertex_arrays_indexed;
597 int vertex_arrays_offset;
600 #define foreach_atom(r300, atom) \
601 for (atom = &r300->gpu_flush; atom != (&r300->query_start)+1; atom++)
603 #define foreach_dirty_atom(r300, atom) \
604 for (atom = r300->first_dirty; atom != r300->last_dirty; atom++)
606 /* Convenience cast wrappers. */
607 static INLINE struct r300_query* r300_query(struct pipe_query* q)
609 return (struct r300_query*)q;
612 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
614 return (struct r300_surface*)surf;
617 static INLINE struct r300_resource* r300_resource(struct pipe_resource* tex)
619 return (struct r300_resource*)tex;
622 static INLINE struct r300_context* r300_context(struct pipe_context* context)
624 return (struct r300_context*)context;
627 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
629 return (struct r300_fragment_shader*)r300->fs.state;
632 static INLINE void r300_mark_atom_dirty(struct r300_context *r300,
633 struct r300_atom *atom)
637 if (!r300->first_dirty) {
638 r300->first_dirty = atom;
639 r300->last_dirty = atom+1;
641 if (atom < r300->first_dirty)
642 r300->first_dirty = atom;
643 else if (atom+1 > r300->last_dirty)
644 r300->last_dirty = atom+1;
648 struct pipe_context* r300_create_context(struct pipe_screen* screen,
651 void r300_flush_cb(void *data);
653 /* Context initialization. */
654 struct draw_stage* r300_draw_stage(struct r300_context* r300);
655 void r300_init_blit_functions(struct r300_context *r300);
656 void r300_init_flush_functions(struct r300_context* r300);
657 void r300_init_query_functions(struct r300_context* r300);
658 void r300_init_render_functions(struct r300_context *r300);
659 void r300_init_state_functions(struct r300_context* r300);
660 void r300_init_resource_functions(struct r300_context* r300);
663 void r300_decompress_zmask(struct r300_context *r300);
664 void r300_decompress_zmask_locked_unsafe(struct r300_context *r300);
665 void r300_decompress_zmask_locked(struct r300_context *r300);
668 void r300_update_hyperz_state(struct r300_context* r300);
671 void r300_resume_query(struct r300_context *r300,
672 struct r300_query *query);
673 void r300_stop_query(struct r300_context *r300);
675 /* r300_render_translate.c */
676 void r300_translate_index_buffer(struct r300_context *r300,
677 struct pipe_resource **index_buffer,
678 unsigned *index_size, unsigned index_offset,
679 unsigned *start, unsigned count);
681 /* r300_render_stencilref.c */
682 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
685 void r300_draw_flush_vbuf(struct r300_context *r300);
686 void r500_emit_index_bias(struct r300_context *r300, int index_bias);
689 enum r300_fb_state_change {
690 R300_CHANGED_FB_STATE = 0,
691 R300_CHANGED_HYPERZ_FLAG,
692 R300_CHANGED_MULTIWRITE
695 void r300_mark_fb_state_dirty(struct r300_context *r300,
696 enum r300_fb_state_change change);
697 void r300_mark_fs_code_dirty(struct r300_context *r300);
699 /* r300_state_derived.c */
700 void r300_update_derived_state(struct r300_context* r300);
703 void r500_dump_rs_block(struct r300_rs_block *rs);
706 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
708 return SCREEN_DBG_ON(ctx->screen, flags);
711 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
712 const char * fmt, ...)
714 if (CTX_DBG_ON(ctx, flags)) {
717 vfprintf(stderr, fmt, va);
722 #define DBG_ON CTX_DBG_ON
725 #endif /* R300_CONTEXT_H */