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"
34 #include "translate/translate_cache.h"
36 #include "r300_defines.h"
37 #include "r300_screen.h"
41 struct r300_fragment_shader;
42 struct r300_vertex_shader;
43 struct r300_stencilref_context;
47 struct r300_atom *prev, *next;
48 /* Name, for debugging. */
54 /* Emit the state to the context. */
55 void (*emit)(struct r300_context*, unsigned, void*);
56 /* Upper bound on number of dwords to emit. */
58 /* Whether this atom should be emitted. */
60 /* Whether this atom may be emitted with state == NULL. */
61 boolean allow_null_state;
64 struct r300_aa_state {
65 struct r300_surface *dest;
68 uint32_t aaresolve_ctl;
71 struct r300_blend_state {
73 uint32_t cb_no_readwrite[8];
76 struct r300_blend_color_state {
80 struct r300_clip_state {
81 struct pipe_clip_state clip;
86 struct r300_dsa_state {
87 struct pipe_depth_stencil_alpha_state dsa;
89 /* This is actually a command buffer with named dwords. */
91 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
93 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
94 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
95 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
97 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
99 /* The second command buffer disables zbuffer reads and writes. */
100 uint32_t cb_no_readwrite[8];
102 /* Whether a two-sided stencil is enabled. */
104 /* Whether a fallback should be used for a two-sided stencil ref value. */
105 boolean two_sided_stencil_ref;
108 struct r300_hyperz_state {
109 int current_func; /* -1 after a clear before first op */
111 /* This is actually a command buffer with named dwords. */
112 uint32_t cb_flush_begin;
113 uint32_t zb_zcache_ctlstat; /* R300_ZB_CACHE_CNTL */
115 uint32_t zb_bw_cntl; /* R300_ZB_BW_CNTL */
117 uint32_t zb_depthclearvalue; /* R300_ZB_DEPTHCLEARVALUE */
119 uint32_t sc_hyperz; /* R300_SC_HYPERZ */
121 uint32_t gb_z_peq_config; /* R300_GB_Z_PEQ_CONFIG: 0x4028 */
124 struct r300_gpu_flush {
125 uint32_t cb_flush_clean[6];
128 struct r300_rs_state {
129 /* Original rasterizer state. */
130 struct pipe_rasterizer_state rs;
131 /* Draw-specific rasterizer state. */
132 struct pipe_rasterizer_state rs_draw;
134 /* Command buffers. */
135 uint32_t cb_main[25];
136 uint32_t cb_poly_offset_zb16[5];
137 uint32_t cb_poly_offset_zb24[5];
139 /* The index to cb_main where the cull_mode register value resides. */
140 unsigned cull_mode_index;
142 /* Whether polygon offset is enabled. */
143 boolean polygon_offset_enable;
145 /* This is emitted in the draw function. */
146 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
149 struct r300_rs_block {
150 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
151 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
152 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
154 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
155 uint32_t count; /* R300_RS_COUNT */
156 uint32_t inst_count; /* R300_RS_INST_COUNT */
157 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
160 struct r300_sampler_state {
161 struct pipe_sampler_state state;
163 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
164 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
165 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
167 /* Min/max LOD must be clamped to [0, last_level], thus
168 * it's dependent on a currently bound texture */
169 unsigned min_lod, max_lod;
172 struct r300_texture_format_state {
173 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
174 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
175 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
176 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
179 struct r300_sampler_view {
180 struct pipe_sampler_view base;
182 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
183 * derived from base. */
184 unsigned char swizzle[4];
186 /* Copy of r300_texture::texture_format_state with format-specific bits
188 struct r300_texture_format_state format;
190 /* The texture cache region for this texture. */
191 uint32_t texcache_region;
194 struct r300_texture_fb_state {
195 uint32_t pitch[R300_MAX_TEXTURE_LEVELS]; /* COLORPITCH or DEPTHPITCH. */
196 uint32_t format; /* US_OUT_FMT or R300_ZB_FORMAT */
199 struct r300_texture_sampler_state {
200 struct r300_texture_format_state format;
201 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
202 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
203 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
206 struct r300_textures_state {
208 struct r300_sampler_view *sampler_views[16];
209 int sampler_view_count;
210 /* Sampler states. */
211 struct r300_sampler_state *sampler_states[16];
212 int sampler_state_count;
214 /* This is the merge of the texture and sampler states. */
216 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
217 struct r300_texture_sampler_state regs[16];
220 struct r300_vertex_stream_state {
221 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
222 uint32_t vap_prog_stream_cntl[8];
223 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
224 uint32_t vap_prog_stream_cntl_ext[8];
229 struct r300_invariant_state {
233 struct r300_vap_invariant_state {
237 struct r300_viewport_state {
238 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
239 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
240 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
241 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
242 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
243 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
244 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
247 struct r300_ztop_state {
248 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
251 /* The next several objects are not pure Radeon state; they inherit from
252 * various Gallium classes. */
254 struct r300_constant_buffer {
255 /* Buffer of constants */
257 /* Remapping table. */
258 unsigned *remap_table;
263 * This is not a subclass of pipe_query because pipe_query is never
264 * actually fully defined. So, rather than have it as a member, and do
265 * subclass-style casting, we treat pipe_query as an opaque, and just
266 * trust that our state tracker does not ever mess up query objects.
269 /* The kind of query. Currently only OQ is supported. */
271 /* The number of pipes where query results are stored. */
273 /* How many results have been written, in dwords. It's incremented
274 * after end_query and flush. */
275 unsigned num_results;
276 /* if we've flushed the query */
278 /* if begin has been emitted */
279 boolean begin_emitted;
281 /* The buffer where query results are stored. */
282 struct r300_winsys_buffer *buffer;
283 /* The size of the buffer. */
284 unsigned buffer_size;
285 /* The domain of the buffer. */
286 enum r300_buffer_domain domain;
288 /* Linked list members. */
289 struct r300_query* prev;
290 struct r300_query* next;
295 * This is a fake fence. Instead of syncing with the fence, we sync
296 * with the context, which is inefficient but compliant.
298 * This is not a subclass of pipe_fence_handle because pipe_fence_handle is
299 * never actually fully defined. So, rather than have it as a member, and do
300 * subclass-style casting, we treat pipe_fence_handle as an opaque, and just
301 * trust that our state tracker does not ever mess up fence objects.
304 struct pipe_reference reference;
305 struct r300_context *ctx;
309 struct r300_surface {
310 struct pipe_surface base;
312 /* Winsys buffer backing the texture. */
313 struct r300_winsys_buffer *buffer;
315 enum r300_buffer_domain domain;
317 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
318 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
319 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
321 /* Parameters dedicated to the CBZB clear. */
322 uint32_t cbzb_width; /* Aligned width. */
323 uint32_t cbzb_height; /* Half of the height. */
324 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
325 uint32_t cbzb_pitch; /* DEPTHPITCH. */
326 uint32_t cbzb_format; /* ZB_FORMAT. */
328 /* Whether the CBZB clear is allowed on the surface. */
329 boolean cbzb_allowed;
333 struct r300_texture_desc {
338 * Macrotiling is specified per-level because small mipmaps cannot
340 enum r300_buffer_tiling microtile;
341 enum r300_buffer_tiling macrotile[R300_MAX_TEXTURE_LEVELS];
343 /* Offsets into the buffer. */
344 unsigned offset_in_bytes[R300_MAX_TEXTURE_LEVELS];
346 /* Strides for each mip-level. */
347 unsigned stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
348 unsigned stride_in_bytes[R300_MAX_TEXTURE_LEVELS];
350 /* Size of one zslice or face or 2D image based on the texture target. */
351 unsigned layer_size_in_bytes[R300_MAX_TEXTURE_LEVELS];
353 /* Total size of this texture, in bytes,
354 * derived from the texture properties. */
355 unsigned size_in_bytes;
357 /* Total size of the buffer backing this texture, in bytes.
358 * It must be >= size. */
359 unsigned buffer_size_in_bytes;
362 * If non-zero, override the natural texture layout with
363 * a custom stride (in bytes).
365 * \note Mipmapping fails for textures with a non-natural layout!
367 * \sa r300_texture_get_stride
369 unsigned stride_in_bytes_override;
371 /* Whether this texture has non-power-of-two dimensions.
372 * It can be either a regular texture or a rectangle one. */
375 /* This flag says that hardware must use the stride for addressing
376 * instead of the width. */
377 boolean uses_stride_addressing;
379 /* Whether CBZB fast color clear is allowed on the miplevel. */
380 boolean cbzb_allowed[R300_MAX_TEXTURE_LEVELS];
383 struct r300_texture {
384 struct r300_texture_desc desc;
386 enum r300_buffer_domain domain;
388 /* Pipe buffer backing this texture. */
389 struct r300_winsys_buffer *buffer;
391 /* Registers carrying texture format data. */
392 /* Only format-independent bits should be filled in. */
393 struct r300_texture_format_state tx_format;
394 /* All bits should be filled in. */
395 struct r300_texture_fb_state fb_state;
397 /* hyper-z memory allocs */
398 struct mem_block *hiz_mem[R300_MAX_TEXTURE_LEVELS];
399 struct mem_block *zmask_mem[R300_MAX_TEXTURE_LEVELS];
400 boolean zmask_in_use[R300_MAX_TEXTURE_LEVELS];
401 boolean hiz_in_use[R300_MAX_TEXTURE_LEVELS];
403 /* This is the level tiling flags were last time set for.
404 * It's used to prevent redundant tiling-flags changes from happening.*/
405 unsigned surface_level;
408 struct r300_vertex_element_state {
410 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
412 /* If (velem[i].src_format != hw_format[i]), the vertex buffer
413 * referenced by this vertex element cannot be used for rendering and
414 * its vertex data must be translated to hw_format[i]. */
415 enum pipe_format hw_format[PIPE_MAX_ATTRIBS];
416 unsigned hw_format_size[PIPE_MAX_ATTRIBS];
418 /* The size of the vertex, in dwords. */
419 unsigned vertex_size_dwords;
421 /* This might mean two things:
422 * - src_format != hw_format, as discussed above.
423 * - src_offset % 4 != 0. */
424 boolean incompatible_layout;
426 struct r300_vertex_stream_state vertex_stream;
429 struct r300_translate_context {
430 /* Translate cache for incompatible vertex offset/stride/format fallback. */
431 struct translate_cache *translate_cache;
433 /* The vertex buffer slot containing the translated buffer. */
436 /* Saved and new vertex element state. */
437 void *saved_velems, *new_velems;
440 struct r300_context {
442 struct pipe_context context;
444 /* The interface to the windowing system, etc. */
445 struct r300_winsys_screen *rws;
446 /* The command stream. */
447 struct r300_winsys_cs *cs;
449 struct r300_screen *screen;
451 /* Draw module. Used mostly for SW TCL. */
452 struct draw_context* draw;
453 /* Vertex buffer for SW TCL. */
454 struct pipe_resource* vbo;
455 /* Offset and size into the SW TCL VBO. */
456 size_t draw_vbo_offset;
457 size_t draw_vbo_size;
458 /* Whether the VBO must not be flushed. */
459 boolean draw_vbo_locked;
460 boolean draw_first_emitted;
462 /* Accelerated blit support. */
463 struct blitter_context* blitter;
464 /* Stencil two-sided reference value fallback. */
465 struct r300_stencilref_context *stencilref_fallback;
466 /* For translating vertex buffers having incompatible vertex layout. */
467 struct r300_translate_context tran;
469 /* The KIL opcode needs the first texture unit to be enabled
470 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
471 * dummy texture there. */
472 struct r300_sampler_view *texkill_sampler;
474 /* The currently active query. */
475 struct r300_query *query_current;
476 /* The saved query for blitter operations. */
477 struct r300_query *blitter_saved_query;
479 struct r300_query query_list;
481 /* Various CSO state objects. */
482 /* Beginning of atom list. */
483 struct r300_atom atom_list;
484 /* Anti-aliasing (MSAA) state. */
485 struct r300_atom aa_state;
487 struct r300_atom blend_state;
488 /* Blend color state. */
489 struct r300_atom blend_color_state;
490 /* User clip planes. */
491 struct r300_atom clip_state;
492 /* Depth, stencil, and alpha state. */
493 struct r300_atom dsa_state;
494 /* Fragment shader. */
496 /* Fragment shader RC_CONSTANT_STATE variables. */
497 struct r300_atom fs_rc_constant_state;
498 /* Fragment shader constant buffer. */
499 struct r300_atom fs_constants;
500 /* Framebuffer state. */
501 struct r300_atom fb_state;
502 /* Framebuffer state (pipelined regs). */
503 struct r300_atom fb_state_pipelined;
504 /* HyperZ state (various SC/ZB bits). */
505 struct r300_atom hyperz_state;
506 /* Occlusion query. */
507 struct r300_atom query_start;
508 /* Rasterizer state. */
509 struct r300_atom rs_state;
510 /* RS block state + VAP (vertex shader) output mapping state. */
511 struct r300_atom rs_block_state;
513 struct r300_atom scissor_state;
514 /* Textures state. */
515 struct r300_atom textures_state;
516 /* Vertex stream formatting state. */
517 struct r300_atom vertex_stream_state;
519 struct r300_atom vs_state;
520 /* Vertex shader constant buffer. */
521 struct r300_atom vs_constants;
522 /* Viewport state. */
523 struct r300_atom viewport_state;
525 struct r300_atom ztop_state;
527 struct r300_atom pvs_flush;
528 /* VAP invariant state. */
529 struct r300_atom vap_invariant_state;
530 /* Texture cache invalidate. */
531 struct r300_atom texture_cache_inval;
533 struct r300_atom gpu_flush;
535 struct r300_atom hiz_clear;
537 struct r300_atom zmask_clear;
539 /* Invariant state. This must be emitted to get the engine started. */
540 struct r300_atom invariant_state;
542 /* Vertex buffers for Gallium. */
543 struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
544 int vertex_buffer_count;
545 int vertex_buffer_max_index;
546 /* Vertex elements for Gallium. */
547 struct r300_vertex_element_state *velems;
550 struct pipe_index_buffer index_buffer;
552 /* Vertex info for Draw. */
553 struct vertex_info vertex_info;
555 struct pipe_stencil_ref stencil_ref;
556 struct pipe_viewport_state viewport;
558 /* Stream locations for SWTCL. */
559 int stream_loc_notcl[16];
561 /* Flag indicating whether or not the HW is dirty. */
563 /* Whether polygon offset is enabled. */
564 boolean polygon_offset_enabled;
565 /* Z buffer bit depth. */
566 uint32_t zbuffer_bpp;
567 /* Whether rendering is conditional and should be skipped. */
568 boolean skip_rendering;
569 /* Point sprites texcoord index, 1 bit per texcoord */
570 int sprite_coord_enable;
571 /* Whether two-sided color selection is enabled (AKA light_twoside). */
572 boolean two_sided_color;
573 /* Incompatible vertex buffer layout? (misaligned stride or buffer_offset) */
574 boolean incompatible_vb_layout;
575 #define R300_Z_COMPRESS_44 1
576 #define RV350_Z_COMPRESS_88 2
581 /* two mem block managers for hiz/zmask ram space */
582 struct mem_block *hiz_mm;
583 struct mem_block *zmask_mm;
585 /* upload managers */
586 struct u_upload_mgr *upload_vb;
587 struct u_upload_mgr *upload_ib;
589 struct util_mempool pool_transfers;
592 uint64_t flush_counter;
595 /* Convenience cast wrappers. */
596 static INLINE struct r300_query* r300_query(struct pipe_query* q)
598 return (struct r300_query*)q;
601 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
603 return (struct r300_surface*)surf;
606 static INLINE struct r300_texture* r300_texture(struct pipe_resource* tex)
608 return (struct r300_texture*)tex;
611 static INLINE struct r300_context* r300_context(struct pipe_context* context)
613 return (struct r300_context*)context;
616 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
618 return (struct r300_fragment_shader*)r300->fs.state;
621 struct pipe_context* r300_create_context(struct pipe_screen* screen,
624 void r300_finish(struct r300_context *r300);
625 void r300_flush_cb(void *data);
627 /* Context initialization. */
628 struct draw_stage* r300_draw_stage(struct r300_context* r300);
629 void r300_init_blit_functions(struct r300_context *r300);
630 void r300_init_flush_functions(struct r300_context* r300);
631 void r300_init_query_functions(struct r300_context* r300);
632 void r300_init_render_functions(struct r300_context *r300);
633 void r300_init_state_functions(struct r300_context* r300);
634 void r300_init_resource_functions(struct r300_context* r300);
637 void r300_flush_depth_stencil(struct pipe_context *pipe,
638 struct pipe_resource *dst,
639 struct pipe_subresource subdst,
643 void r300_resume_query(struct r300_context *r300,
644 struct r300_query *query);
645 void r300_stop_query(struct r300_context *r300);
647 /* r300_render_translate.c */
648 void r300_begin_vertex_translate(struct r300_context *r300);
649 void r300_end_vertex_translate(struct r300_context *r300);
650 void r300_translate_index_buffer(struct r300_context *r300,
651 struct pipe_resource **index_buffer,
652 unsigned *index_size, unsigned index_offset,
653 unsigned *start, unsigned count);
655 /* r300_render_stencilref.c */
656 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
659 void r300_draw_flush_vbuf(struct r300_context *r300);
660 boolean r500_index_bias_supported(struct r300_context *r300);
661 void r500_emit_index_bias(struct r300_context *r300, int index_bias);
664 enum r300_fb_state_change {
665 R300_CHANGED_FB_STATE = 0,
666 R300_CHANGED_CBZB_FLAG,
667 R300_CHANGED_ZCLEAR_FLAG
670 void r300_mark_fb_state_dirty(struct r300_context *r300,
671 enum r300_fb_state_change change);
672 void r300_mark_fs_code_dirty(struct r300_context *r300);
675 void r500_dump_rs_block(struct r300_rs_block *rs);
678 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
680 return SCREEN_DBG_ON(ctx->screen, flags);
683 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
684 const char * fmt, ...)
686 if (CTX_DBG_ON(ctx, flags)) {
689 vfprintf(stderr, fmt, va);
694 #define DBG_ON CTX_DBG_ON
697 #endif /* R300_CONTEXT_H */