r300g: Miscellania. Avoid draw segfaults, s/true/TRUE/, etc.
[mesa.git] / src / gallium / drivers / r300 / r300_context.h
1 /*
2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
3 *
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:
10 *
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
13 * Software.
14 *
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. */
22
23 #ifndef R300_CONTEXT_H
24 #define R300_CONTEXT_H
25
26 #include "draw/draw_vertex.h"
27
28 #include "pipe/p_context.h"
29 #include "pipe/p_inlines.h"
30
31 struct r300_fragment_shader;
32 struct r300_vertex_shader;
33
34 struct r300_blend_state {
35 uint32_t blend_control; /* R300_RB3D_CBLEND: 0x4e04 */
36 uint32_t alpha_blend_control; /* R300_RB3D_ABLEND: 0x4e08 */
37 uint32_t rop; /* R300_RB3D_ROPCNTL: 0x4e18 */
38 uint32_t dither; /* R300_RB3D_DITHER_CTL: 0x4e50 */
39 };
40
41 struct r300_blend_color_state {
42 /* RV515 and earlier */
43 uint32_t blend_color; /* R300_RB3D_BLEND_COLOR: 0x4e10 */
44 /* R520 and newer */
45 uint32_t blend_color_red_alpha; /* R500_RB3D_CONSTANT_COLOR_AR: 0x4ef8 */
46 uint32_t blend_color_green_blue; /* R500_RB3D_CONSTANT_COLOR_GB: 0x4efc */
47 };
48
49 struct r300_dsa_state {
50 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
51 uint32_t alpha_reference; /* R500_FG_ALPHA_VALUE: 0x4be0 */
52 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
53 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
54 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
55 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
56 };
57
58 struct r300_rs_state {
59 /* Draw-specific rasterizer state */
60 struct pipe_rasterizer_state rs;
61
62 /* Whether or not to enable the VTE. This is referenced at the very
63 * last moment during emission of VTE state, to decide whether or not
64 * the VTE should be used for transformation. */
65 boolean enable_vte;
66
67 uint32_t vap_control_status; /* R300_VAP_CNTL_STATUS: 0x2140 */
68 uint32_t point_size; /* R300_GA_POINT_SIZE: 0x421c */
69 uint32_t point_minmax; /* R300_GA_POINT_MINMAX: 0x4230 */
70 uint32_t line_control; /* R300_GA_LINE_CNTL: 0x4234 */
71 uint32_t depth_scale_front; /* R300_SU_POLY_OFFSET_FRONT_SCALE: 0x42a4 */
72 uint32_t depth_offset_front;/* R300_SU_POLY_OFFSET_FRONT_OFFSET: 0x42a8 */
73 uint32_t depth_scale_back; /* R300_SU_POLY_OFFSET_BACK_SCALE: 0x42ac */
74 uint32_t depth_offset_back; /* R300_SU_POLY_OFFSET_BACK_OFFSET: 0x42b0 */
75 uint32_t polygon_offset_enable; /* R300_SU_POLY_OFFSET_ENABLE: 0x42b4 */
76 uint32_t cull_mode; /* R300_SU_CULL_MODE: 0x42b8 */
77 uint32_t line_stipple_config; /* R300_GA_LINE_STIPPLE_CONFIG: 0x4328 */
78 uint32_t line_stipple_value; /* R300_GA_LINE_STIPPLE_VALUE: 0x4260 */
79 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
80 };
81
82 struct r300_rs_block {
83 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
84 uint32_t count; /* R300_RS_COUNT */
85 uint32_t inst_count; /* R300_RS_INST_COUNT */
86 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
87 };
88
89 struct r300_sampler_state {
90 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
91 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
92 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
93 };
94
95 struct r300_scissor_state {
96 uint32_t scissor_top_left; /* R300_SC_SCISSORS_TL: 0x43e0 */
97 uint32_t scissor_bottom_right; /* R300_SC_SCISSORS_BR: 0x43e4 */
98 };
99
100 struct r300_texture_state {
101 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
102 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
103 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
104 };
105
106 struct r300_viewport_state {
107 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
108 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
109 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
110 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
111 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
112 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
113 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
114 };
115
116 struct r300_ztop_state {
117 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
118 };
119
120 #define R300_NEW_BLEND 0x00000001
121 #define R300_NEW_BLEND_COLOR 0x00000002
122 #define R300_NEW_CLIP 0x00000004
123 #define R300_NEW_DSA 0x00000008
124 #define R300_NEW_FRAMEBUFFERS 0x00000010
125 #define R300_NEW_FRAGMENT_SHADER 0x00000020
126 #define R300_NEW_FRAGMENT_SHADER_CONSTANTS 0x00000040
127 #define R300_NEW_RASTERIZER 0x00000080
128 #define R300_NEW_RS_BLOCK 0x00000100
129 #define R300_NEW_SAMPLER 0x00000200
130 #define R300_ANY_NEW_SAMPLERS 0x0001fe00
131 #define R300_NEW_SCISSOR 0x00020000
132 #define R300_NEW_TEXTURE 0x00040000
133 #define R300_ANY_NEW_TEXTURES 0x03fc0000
134 #define R300_NEW_VERTEX_FORMAT 0x04000000
135 #define R300_NEW_VERTEX_SHADER 0x08000000
136 #define R300_NEW_VERTEX_SHADER_CONSTANTS 0x10000000
137 #define R300_NEW_VIEWPORT 0x20000000
138 #define R300_NEW_QUERY 0x40000000
139 #define R300_NEW_KITCHEN_SINK 0x7fffffff
140
141 /* The next several objects are not pure Radeon state; they inherit from
142 * various Gallium classes. */
143
144 struct r300_constant_buffer {
145 /* Buffer of constants */
146 /* XXX first number should be raised */
147 float constants[32][4];
148 /* Total number of constants */
149 unsigned count;
150 };
151
152 /* Query object.
153 *
154 * This is not a subclass of pipe_query because pipe_query is never
155 * actually fully defined. So, rather than have it as a member, and do
156 * subclass-style casting, we treat pipe_query as an opaque, and just
157 * trust that our state tracker does not ever mess up query objects.
158 */
159 struct r300_query {
160 /* The kind of query. Currently only OQ is supported. */
161 unsigned type;
162 /* Whether this query is currently active. Only active queries will
163 * get emitted into the command stream, and only active queries get
164 * tallied. */
165 boolean active;
166 /* The current count of this query. Required to be at least 32 bits. */
167 unsigned int count;
168 /* The offset of this query into the query buffer, in bytes. */
169 unsigned offset;
170 /* if we've flushed the query */
171 boolean flushed;
172 /* if begin has been emitted */
173 boolean begin_emitted;
174 /* Linked list members. */
175 struct r300_query* prev;
176 struct r300_query* next;
177 };
178
179 struct r300_texture {
180 /* Parent class */
181 struct pipe_texture tex;
182
183 /* Offsets into the buffer. */
184 unsigned offset[PIPE_MAX_TEXTURE_LEVELS];
185
186 /* A pitch for each mip-level */
187 unsigned pitch[PIPE_MAX_TEXTURE_LEVELS];
188
189 /* Size of one zslice or face based on the texture target */
190 unsigned layer_size[PIPE_MAX_TEXTURE_LEVELS];
191
192 /**
193 * If non-zero, override the natural texture layout with
194 * a custom stride (in bytes).
195 *
196 * \note Mipmapping fails for textures with a non-natural layout!
197 *
198 * \sa r300_texture_get_stride
199 */
200 unsigned stride_override;
201
202 /* Total size of this texture, in bytes. */
203 unsigned size;
204
205 /* Whether this texture has non-power-of-two dimensions.
206 * It can be either a regular texture or a rectangle one.
207 */
208 boolean is_npot;
209
210 /* Pipe buffer backing this texture. */
211 struct pipe_buffer* buffer;
212
213 /* Registers carrying texture format data. */
214 struct r300_texture_state state;
215 };
216
217 struct r300_vertex_format {
218 /* Parent class */
219 struct vertex_info vinfo;
220 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
221 uint32_t vap_prog_stream_cntl[8];
222 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
223 uint32_t vap_prog_stream_cntl_ext[8];
224 /* Map of vertex attributes into PVS memory for HW TCL,
225 * or GA memory for SW TCL. */
226 int vs_tab[16];
227 /* Map of rasterizer attributes from GB through RS to US. */
228 int fs_tab[16];
229 };
230
231 extern struct pipe_viewport_state r300_viewport_identity;
232
233 struct r300_context {
234 /* Parent class */
235 struct pipe_context context;
236
237 /* The interface to the windowing system, etc. */
238 struct r300_winsys* winsys;
239 /* Draw module. Used mostly for SW TCL. */
240 struct draw_context* draw;
241
242 /* Vertex buffer for rendering. */
243 struct pipe_buffer* vbo;
244 /* Offset into the VBO. */
245 size_t vbo_offset;
246
247 /* Occlusion query buffer. */
248 struct pipe_buffer* oqbo;
249 /* Query list. */
250 struct r300_query *query_current;
251 struct r300_query query_list;
252
253 /* Shader hash table. Used to store vertex formatting information, which
254 * depends on the combination of both currently loaded shaders. */
255 struct util_hash_table* shader_hash_table;
256 /* Vertex formatting information. */
257 struct r300_vertex_format* vertex_info;
258
259 /* Various CSO state objects. */
260 /* Blend state. */
261 struct r300_blend_state* blend_state;
262 /* Blend color state. */
263 struct r300_blend_color_state* blend_color_state;
264 /* User clip planes. */
265 struct pipe_clip_state clip_state;
266 /* Shader constants. */
267 struct r300_constant_buffer shader_constants[PIPE_SHADER_TYPES];
268 /* Depth, stencil, and alpha state. */
269 struct r300_dsa_state* dsa_state;
270 /* Fragment shader. */
271 struct r300_fragment_shader* fs;
272 /* Framebuffer state. We currently don't need our own version of this. */
273 struct pipe_framebuffer_state framebuffer_state;
274 /* Rasterizer state. */
275 struct r300_rs_state* rs_state;
276 /* RS block state. */
277 struct r300_rs_block* rs_block;
278 /* Sampler states. */
279 struct r300_sampler_state* sampler_states[8];
280 int sampler_count;
281 /* Scissor state. */
282 struct r300_scissor_state* scissor_state;
283 /* Texture states. */
284 struct r300_texture* textures[8];
285 int texture_count;
286 /* Vertex buffers for Gallium. */
287 struct pipe_vertex_buffer vertex_buffers[PIPE_MAX_ATTRIBS];
288 int vertex_buffer_count;
289 /* Vertex elements for Gallium. */
290 struct pipe_vertex_element vertex_elements[PIPE_MAX_ATTRIBS];
291 int vertex_element_count;
292 /* Vertex shader. */
293 struct r300_vertex_shader* vs;
294 /* Viewport state. */
295 struct r300_viewport_state* viewport_state;
296 /* ZTOP state. */
297 struct r300_ztop_state ztop_state;
298
299 /* Bitmask of dirty state objects. */
300 uint32_t dirty_state;
301 /* Flag indicating whether or not the HW is dirty. */
302 uint32_t dirty_hw;
303
304 /** Combination of DBG_xxx flags */
305 unsigned debug;
306 };
307
308 /* Convenience cast wrapper. */
309 static INLINE struct r300_context* r300_context(struct pipe_context* context)
310 {
311 return (struct r300_context*)context;
312 }
313
314 /* Context initialization. */
315 struct draw_stage* r300_draw_stage(struct r300_context* r300);
316 void r300_init_state_functions(struct r300_context* r300);
317 void r300_init_surface_functions(struct r300_context* r300);
318
319 /* Debug functionality. */
320
321 /**
322 * Debug flags to disable/enable certain groups of debugging outputs.
323 *
324 * \note These may be rather coarse, and the grouping may be impractical.
325 * If you find, while debugging the driver, that a different grouping
326 * of these flags would be beneficial, just feel free to change them
327 * but make sure to update the documentation in r300_debug.c to reflect
328 * those changes.
329 */
330 /*@{*/
331 #define DBG_HELP 0x0000001
332 #define DBG_FP 0x0000002
333 #define DBG_VP 0x0000004
334 #define DBG_CS 0x0000008
335 #define DBG_DRAW 0x0000010
336 #define DBG_TEX 0x0000020
337 #define DBG_FALL 0x0000040
338 /*@}*/
339
340 static INLINE boolean DBG_ON(struct r300_context * ctx, unsigned flags)
341 {
342 return (ctx->debug & flags) ? TRUE : FALSE;
343 }
344
345 static INLINE void DBG(struct r300_context * ctx, unsigned flags, const char * fmt, ...)
346 {
347 if (DBG_ON(ctx, flags)) {
348 va_list va;
349 va_start(va, fmt);
350 debug_vprintf(fmt, va);
351 va_end(va);
352 }
353 }
354
355 void r300_init_debug(struct r300_context * ctx);
356
357 #endif /* R300_CONTEXT_H */