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 #define RS_STATE_MAIN_SIZE 23
130 struct r300_rs_state {
131 /* Original rasterizer state. */
132 struct pipe_rasterizer_state rs;
133 /* Draw-specific rasterizer state. */
134 struct pipe_rasterizer_state rs_draw;
136 /* Command buffers. */
137 uint32_t cb_main[RS_STATE_MAIN_SIZE];
138 uint32_t cb_poly_offset_zb16[5];
139 uint32_t cb_poly_offset_zb24[5];
141 /* The index to cb_main where the cull_mode register value resides. */
142 unsigned cull_mode_index;
144 /* Whether polygon offset is enabled. */
145 boolean polygon_offset_enable;
147 /* This is emitted in the draw function. */
148 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
151 struct r300_rs_block {
152 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
153 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
154 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
157 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
158 uint32_t count; /* R300_RS_COUNT */
159 uint32_t inst_count; /* R300_RS_INST_COUNT */
160 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
163 struct r300_sampler_state {
164 struct pipe_sampler_state state;
166 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
167 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
169 /* Min/max LOD must be clamped to [0, last_level], thus
170 * it's dependent on a currently bound texture */
171 unsigned min_lod, max_lod;
174 struct r300_texture_format_state {
175 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
176 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
177 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
178 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
181 struct r300_sampler_view {
182 struct pipe_sampler_view base;
184 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
185 * derived from base. */
186 unsigned char swizzle[4];
188 /* Copy of r300_texture::texture_format_state with format-specific bits
190 struct r300_texture_format_state format;
192 /* The texture cache region for this texture. */
193 uint32_t texcache_region;
196 struct r300_texture_fb_state {
197 uint32_t pitch[R300_MAX_TEXTURE_LEVELS]; /* COLORPITCH or DEPTHPITCH. */
198 uint32_t format; /* US_OUT_FMT or R300_ZB_FORMAT */
201 struct r300_texture_sampler_state {
202 struct r300_texture_format_state format;
203 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
204 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
205 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
208 struct r300_textures_state {
210 struct r300_sampler_view *sampler_views[16];
211 int sampler_view_count;
212 /* Sampler states. */
213 struct r300_sampler_state *sampler_states[16];
214 int sampler_state_count;
216 /* This is the merge of the texture and sampler states. */
218 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
219 struct r300_texture_sampler_state regs[16];
222 struct r300_vertex_stream_state {
223 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
224 uint32_t vap_prog_stream_cntl[8];
225 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
226 uint32_t vap_prog_stream_cntl_ext[8];
231 struct r300_invariant_state {
235 struct r300_vap_invariant_state {
239 struct r300_viewport_state {
240 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
241 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
242 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
243 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
244 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
245 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
246 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
249 struct r300_ztop_state {
250 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
253 /* The next several objects are not pure Radeon state; they inherit from
254 * various Gallium classes. */
256 struct r300_constant_buffer {
257 /* Buffer of constants */
259 /* Remapping table. */
260 unsigned *remap_table;
265 * This is not a subclass of pipe_query because pipe_query is never
266 * actually fully defined. So, rather than have it as a member, and do
267 * subclass-style casting, we treat pipe_query as an opaque, and just
268 * trust that our state tracker does not ever mess up query objects.
271 /* The kind of query. Currently only OQ is supported. */
273 /* The number of pipes where query results are stored. */
275 /* How many results have been written, in dwords. It's incremented
276 * after end_query and flush. */
277 unsigned num_results;
278 /* if we've flushed the query */
280 /* if begin has been emitted */
281 boolean begin_emitted;
283 /* The buffer where query results are stored. */
284 struct r300_winsys_buffer *buffer;
285 /* The size of the buffer. */
286 unsigned buffer_size;
287 /* The domain of the buffer. */
288 enum r300_buffer_domain domain;
290 /* Linked list members. */
291 struct r300_query* prev;
292 struct r300_query* next;
297 * This is a fake fence. Instead of syncing with the fence, we sync
298 * with the context, which is inefficient but compliant.
300 * This is not a subclass of pipe_fence_handle because pipe_fence_handle is
301 * never actually fully defined. So, rather than have it as a member, and do
302 * subclass-style casting, we treat pipe_fence_handle as an opaque, and just
303 * trust that our state tracker does not ever mess up fence objects.
306 struct pipe_reference reference;
307 struct r300_context *ctx;
311 struct r300_surface {
312 struct pipe_surface base;
314 /* Winsys buffer backing the texture. */
315 struct r300_winsys_buffer *buffer;
317 enum r300_buffer_domain domain;
319 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
320 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
321 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
323 /* Parameters dedicated to the CBZB clear. */
324 uint32_t cbzb_width; /* Aligned width. */
325 uint32_t cbzb_height; /* Half of the height. */
326 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
327 uint32_t cbzb_pitch; /* DEPTHPITCH. */
328 uint32_t cbzb_format; /* ZB_FORMAT. */
330 /* Whether the CBZB clear is allowed on the surface. */
331 boolean cbzb_allowed;
335 struct r300_texture_desc {
340 * Macrotiling is specified per-level because small mipmaps cannot
342 enum r300_buffer_tiling microtile;
343 enum r300_buffer_tiling macrotile[R300_MAX_TEXTURE_LEVELS];
345 /* Offsets into the buffer. */
346 unsigned offset_in_bytes[R300_MAX_TEXTURE_LEVELS];
348 /* Strides for each mip-level. */
349 unsigned stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
350 unsigned stride_in_bytes[R300_MAX_TEXTURE_LEVELS];
352 /* Size of one zslice or face or 2D image based on the texture target. */
353 unsigned layer_size_in_bytes[R300_MAX_TEXTURE_LEVELS];
355 /* Total size of this texture, in bytes,
356 * derived from the texture properties. */
357 unsigned size_in_bytes;
359 /* Total size of the buffer backing this texture, in bytes.
360 * It must be >= size. */
361 unsigned buffer_size_in_bytes;
364 * If non-zero, override the natural texture layout with
365 * a custom stride (in bytes).
367 * \note Mipmapping fails for textures with a non-natural layout!
369 * \sa r300_texture_get_stride
371 unsigned stride_in_bytes_override;
373 /* Whether this texture has non-power-of-two dimensions.
374 * It can be either a regular texture or a rectangle one. */
377 /* This flag says that hardware must use the stride for addressing
378 * instead of the width. */
379 boolean uses_stride_addressing;
381 /* Whether CBZB fast color clear is allowed on the miplevel. */
382 boolean cbzb_allowed[R300_MAX_TEXTURE_LEVELS];
385 struct r300_texture {
386 struct r300_texture_desc desc;
388 enum r300_buffer_domain domain;
390 /* Pipe buffer backing this texture. */
391 struct r300_winsys_buffer *buffer;
393 /* Registers carrying texture format data. */
394 /* Only format-independent bits should be filled in. */
395 struct r300_texture_format_state tx_format;
396 /* All bits should be filled in. */
397 struct r300_texture_fb_state fb_state;
399 /* hyper-z memory allocs */
400 struct mem_block *hiz_mem[R300_MAX_TEXTURE_LEVELS];
401 struct mem_block *zmask_mem[R300_MAX_TEXTURE_LEVELS];
402 boolean zmask_in_use[R300_MAX_TEXTURE_LEVELS];
403 boolean hiz_in_use[R300_MAX_TEXTURE_LEVELS];
405 /* This is the level tiling flags were last time set for.
406 * It's used to prevent redundant tiling-flags changes from happening.*/
407 unsigned surface_level;
410 struct r300_vertex_element_state {
412 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
414 /* If (velem[i].src_format != hw_format[i]), the vertex buffer
415 * referenced by this vertex element cannot be used for rendering and
416 * its vertex data must be translated to hw_format[i]. */
417 enum pipe_format hw_format[PIPE_MAX_ATTRIBS];
418 unsigned hw_format_size[PIPE_MAX_ATTRIBS];
420 /* The size of the vertex, in dwords. */
421 unsigned vertex_size_dwords;
423 /* This might mean two things:
424 * - src_format != hw_format, as discussed above.
425 * - src_offset % 4 != 0. */
426 boolean incompatible_layout;
428 struct r300_vertex_stream_state vertex_stream;
431 struct r300_translate_context {
432 /* Translate cache for incompatible vertex offset/stride/format fallback. */
433 struct translate_cache *translate_cache;
435 /* The vertex buffer slot containing the translated buffer. */
438 /* Saved and new vertex element state. */
439 void *saved_velems, *new_velems;
442 struct r300_context {
444 struct pipe_context context;
446 /* The interface to the windowing system, etc. */
447 struct r300_winsys_screen *rws;
448 /* The command stream. */
449 struct r300_winsys_cs *cs;
451 struct r300_screen *screen;
453 /* Draw module. Used mostly for SW TCL. */
454 struct draw_context* draw;
455 /* Vertex buffer for SW TCL. */
456 struct pipe_resource* vbo;
457 /* Offset and size into the SW TCL VBO. */
458 size_t draw_vbo_offset;
459 size_t draw_vbo_size;
460 /* Whether the VBO must not be flushed. */
461 boolean draw_vbo_locked;
462 boolean draw_first_emitted;
464 /* Accelerated blit support. */
465 struct blitter_context* blitter;
466 /* Stencil two-sided reference value fallback. */
467 struct r300_stencilref_context *stencilref_fallback;
468 /* For translating vertex buffers having incompatible vertex layout. */
469 struct r300_translate_context tran;
471 /* The KIL opcode needs the first texture unit to be enabled
472 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
473 * dummy texture there. */
474 struct r300_sampler_view *texkill_sampler;
476 /* The currently active query. */
477 struct r300_query *query_current;
478 /* The saved query for blitter operations. */
479 struct r300_query *blitter_saved_query;
481 struct r300_query query_list;
483 /* Various CSO state objects. */
484 /* Beginning of atom list. */
485 struct r300_atom atom_list;
486 /* Anti-aliasing (MSAA) state. */
487 struct r300_atom aa_state;
489 struct r300_atom blend_state;
490 /* Blend color state. */
491 struct r300_atom blend_color_state;
492 /* User clip planes. */
493 struct r300_atom clip_state;
494 /* Depth, stencil, and alpha state. */
495 struct r300_atom dsa_state;
496 /* Fragment shader. */
498 /* Fragment shader RC_CONSTANT_STATE variables. */
499 struct r300_atom fs_rc_constant_state;
500 /* Fragment shader constant buffer. */
501 struct r300_atom fs_constants;
502 /* Framebuffer state. */
503 struct r300_atom fb_state;
504 /* Framebuffer state (pipelined regs). */
505 struct r300_atom fb_state_pipelined;
506 /* HyperZ state (various SC/ZB bits). */
507 struct r300_atom hyperz_state;
508 /* Occlusion query. */
509 struct r300_atom query_start;
510 /* Rasterizer state. */
511 struct r300_atom rs_state;
512 /* RS block state + VAP (vertex shader) output mapping state. */
513 struct r300_atom rs_block_state;
515 struct r300_atom scissor_state;
516 /* Textures state. */
517 struct r300_atom textures_state;
518 /* Vertex stream formatting state. */
519 struct r300_atom vertex_stream_state;
521 struct r300_atom vs_state;
522 /* Vertex shader constant buffer. */
523 struct r300_atom vs_constants;
524 /* Viewport state. */
525 struct r300_atom viewport_state;
527 struct r300_atom ztop_state;
529 struct r300_atom pvs_flush;
530 /* VAP invariant state. */
531 struct r300_atom vap_invariant_state;
532 /* Texture cache invalidate. */
533 struct r300_atom texture_cache_inval;
535 struct r300_atom gpu_flush;
537 struct r300_atom hiz_clear;
539 struct r300_atom zmask_clear;
541 /* Invariant state. This must be emitted to get the engine started. */
542 struct r300_atom invariant_state;
544 /* Vertex buffers for Gallium. */
545 struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
546 int vertex_buffer_count;
547 int vertex_buffer_max_index;
548 /* Vertex elements for Gallium. */
549 struct r300_vertex_element_state *velems;
552 struct pipe_index_buffer index_buffer;
554 /* Vertex info for Draw. */
555 struct vertex_info vertex_info;
557 struct pipe_stencil_ref stencil_ref;
558 struct pipe_viewport_state viewport;
560 /* Stream locations for SWTCL. */
561 int stream_loc_notcl[16];
563 /* Flag indicating whether or not the HW is dirty. */
565 /* Whether polygon offset is enabled. */
566 boolean polygon_offset_enabled;
567 /* Z buffer bit depth. */
568 uint32_t zbuffer_bpp;
569 /* Whether rendering is conditional and should be skipped. */
570 boolean skip_rendering;
571 /* Point sprites texcoord index, 1 bit per texcoord */
572 int sprite_coord_enable;
573 /* Whether two-sided color selection is enabled (AKA light_twoside). */
574 boolean two_sided_color;
575 /* Incompatible vertex buffer layout? (misaligned stride or buffer_offset) */
576 boolean incompatible_vb_layout;
577 #define R300_Z_COMPRESS_44 1
578 #define RV350_Z_COMPRESS_88 2
583 /* two mem block managers for hiz/zmask ram space */
584 struct mem_block *hiz_mm;
585 struct mem_block *zmask_mm;
587 /* upload managers */
588 struct u_upload_mgr *upload_vb;
589 struct u_upload_mgr *upload_ib;
591 struct util_mempool pool_transfers;
594 uint64_t flush_counter;
597 /* Convenience cast wrappers. */
598 static INLINE struct r300_query* r300_query(struct pipe_query* q)
600 return (struct r300_query*)q;
603 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
605 return (struct r300_surface*)surf;
608 static INLINE struct r300_texture* r300_texture(struct pipe_resource* tex)
610 return (struct r300_texture*)tex;
613 static INLINE struct r300_context* r300_context(struct pipe_context* context)
615 return (struct r300_context*)context;
618 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
620 return (struct r300_fragment_shader*)r300->fs.state;
623 struct pipe_context* r300_create_context(struct pipe_screen* screen,
626 void r300_finish(struct r300_context *r300);
627 void r300_flush_cb(void *data);
629 /* Context initialization. */
630 struct draw_stage* r300_draw_stage(struct r300_context* r300);
631 void r300_init_blit_functions(struct r300_context *r300);
632 void r300_init_flush_functions(struct r300_context* r300);
633 void r300_init_query_functions(struct r300_context* r300);
634 void r300_init_render_functions(struct r300_context *r300);
635 void r300_init_state_functions(struct r300_context* r300);
636 void r300_init_resource_functions(struct r300_context* r300);
639 void r300_flush_depth_stencil(struct pipe_context *pipe,
640 struct pipe_resource *dst,
641 struct pipe_subresource subdst,
645 void r300_resume_query(struct r300_context *r300,
646 struct r300_query *query);
647 void r300_stop_query(struct r300_context *r300);
649 /* r300_render_translate.c */
650 void r300_begin_vertex_translate(struct r300_context *r300);
651 void r300_end_vertex_translate(struct r300_context *r300);
652 void r300_translate_index_buffer(struct r300_context *r300,
653 struct pipe_resource **index_buffer,
654 unsigned *index_size, unsigned index_offset,
655 unsigned *start, unsigned count);
657 /* r300_render_stencilref.c */
658 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
661 void r300_draw_flush_vbuf(struct r300_context *r300);
662 boolean r500_index_bias_supported(struct r300_context *r300);
663 void r500_emit_index_bias(struct r300_context *r300, int index_bias);
666 enum r300_fb_state_change {
667 R300_CHANGED_FB_STATE = 0,
668 R300_CHANGED_CBZB_FLAG,
669 R300_CHANGED_ZCLEAR_FLAG
672 void r300_mark_fb_state_dirty(struct r300_context *r300,
673 enum r300_fb_state_change change);
674 void r300_mark_fs_code_dirty(struct r300_context *r300);
677 void r500_dump_rs_block(struct r300_rs_block *rs);
680 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
682 return SCREEN_DBG_ON(ctx->screen, flags);
685 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
686 const char * fmt, ...)
688 if (CTX_DBG_ON(ctx, flags)) {
691 vfprintf(stderr, fmt, va);
696 #define DBG_ON CTX_DBG_ON
699 #endif /* R300_CONTEXT_H */