src/gallium/drivers/freedreno/freedreno_util.h

   1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
   2
   3 /*
   4  * Copyright (C) 2012 Rob Clark <robclark@freedesktop.org>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *    Rob Clark <robclark@freedesktop.org>
  27  */
  28
  29 #ifndef FREEDRENO_UTIL_H_
  30 #define FREEDRENO_UTIL_H_
  31
  32 #include <freedreno_drmif.h>
  33 #include <freedreno_ringbuffer.h>
  34
  35 #include "pipe/p_format.h"
  36 #include "pipe/p_state.h"
  37 #include "util/u_debug.h"
  38 #include "util/u_math.h"
  39 #include "util/u_half.h"
  40 #include "util/u_dynarray.h"
  41 #include "util/u_pack_color.h"
  42
  43 #include "disasm.h"
  44 #include "adreno_common.xml.h"
  45 #include "adreno_pm4.xml.h"
  46
  47 enum adreno_rb_depth_format fd_pipe2depth(enum pipe_format format);
  48 enum pc_di_index_size fd_pipe2index(enum pipe_format format);
  49 enum adreno_rb_blend_factor fd_blend_factor(unsigned factor);
  50 enum adreno_pa_su_sc_draw fd_polygon_mode(unsigned mode);
  51 enum adreno_stencil_op fd_stencil_op(unsigned op);
  52
  53 #define A3XX_MAX_MIP_LEVELS 14
  54 /* TBD if it is same on a2xx, but for now: */
  55 #define MAX_MIP_LEVELS A3XX_MAX_MIP_LEVELS
  56
  57 #define A2XX_MAX_RENDER_TARGETS 1
  58 #define A3XX_MAX_RENDER_TARGETS 4
  59 #define A4XX_MAX_RENDER_TARGETS 8
  60 /* for now until a4xx MRT support: */
  61 #define MAX_RENDER_TARGETS A3XX_MAX_RENDER_TARGETS
  62
  63 #define FD_DBG_MSGS     0x0001
  64 #define FD_DBG_DISASM   0x0002
  65 #define FD_DBG_DCLEAR   0x0004
  66 #define FD_DBG_FLUSH    0x0008
  67 #define FD_DBG_NOSCIS   0x0010
  68 #define FD_DBG_DIRECT   0x0020
  69 #define FD_DBG_NOBYPASS 0x0040
  70 #define FD_DBG_FRAGHALF 0x0080
  71 #define FD_DBG_NOBIN    0x0100
  72 #define FD_DBG_OPTMSGS  0x0200
  73 #define FD_DBG_GLSL120  0x0400
  74 #define FD_DBG_SHADERDB 0x0800
  75
  76 extern int fd_mesa_debug;
  77 extern bool fd_binning_enabled;
  78
  79 #define DBG(fmt, ...) \
  80                 do { if (fd_mesa_debug & FD_DBG_MSGS) \
  81                         debug_printf("%s:%d: "fmt "\n", \
  82                                 __FUNCTION__, __LINE__, ##__VA_ARGS__); } while (0)
  83
  84 /* for conditionally setting boolean flag(s): */
  85 #define COND(bool, val) ((bool) ? (val) : 0)
  86
  87 #define CP_REG(reg) ((0x4 << 16) | ((unsigned int)((reg) - (0x2000))))
  88
  89 static inline uint32_t DRAW(enum pc_di_primtype prim_type,
  90                 enum pc_di_src_sel source_select, enum pc_di_index_size index_size,
  91                 enum pc_di_vis_cull_mode vis_cull_mode,
  92                 uint8_t instances)
  93 {
  94         return (prim_type         << 0) |
  95                         (source_select     << 6) |
  96                         ((index_size & 1)  << 11) |
  97                         ((index_size >> 1) << 13) |
  98                         (vis_cull_mode     << 9) |
  99                         (1                 << 14) |
 100                         (instances         << 24);
 101 }
 102
 103 /* for tracking cmdstream positions that need to be patched: */
 104 struct fd_cs_patch {
 105         uint32_t *cs;
 106         uint32_t val;
 107 };
 108 #define fd_patch_num_elements(buf) ((buf)->size / sizeof(struct fd_cs_patch))
 109 #define fd_patch_element(buf, i)   util_dynarray_element(buf, struct fd_cs_patch, i)
 110
 111 static inline enum pipe_format
 112 pipe_surface_format(struct pipe_surface *psurf)
 113 {
 114         if (!psurf)
 115                 return PIPE_FORMAT_NONE;
 116         return psurf->format;
 117 }
 118
 119 #define LOG_DWORDS 0
 120
 121 static inline void emit_marker(struct fd_ringbuffer *ring, int scratch_idx);
 122
 123 static inline void
 124 OUT_RING(struct fd_ringbuffer *ring, uint32_t data)
 125 {
 126         if (LOG_DWORDS) {
 127                 DBG("ring[%p]: OUT_RING   %04x:  %08x", ring,
 128                                 (uint32_t)(ring->cur - ring->last_start), data);
 129         }
 130         *(ring->cur++) = data;
 131 }
 132
 133 /* like OUT_RING() but appends a cmdstream patch point to 'buf' */
 134 static inline void
 135 OUT_RINGP(struct fd_ringbuffer *ring, uint32_t data,
 136                 struct util_dynarray *buf)
 137 {
 138         if (LOG_DWORDS) {
 139                 DBG("ring[%p]: OUT_RINGP  %04x:  %08x", ring,
 140                                 (uint32_t)(ring->cur - ring->last_start), data);
 141         }
 142         util_dynarray_append(buf, struct fd_cs_patch, ((struct fd_cs_patch){
 143                 .cs  = ring->cur++,
 144                 .val = data,
 145         }));
 146 }
 147
 148 static inline void
 149 OUT_RELOC(struct fd_ringbuffer *ring, struct fd_bo *bo,
 150                 uint32_t offset, uint32_t or, int32_t shift)
 151 {
 152         if (LOG_DWORDS) {
 153                 DBG("ring[%p]: OUT_RELOC   %04x:  %p+%u << %d", ring,
 154                                 (uint32_t)(ring->cur - ring->last_start), bo, offset, shift);
 155         }
 156         fd_ringbuffer_reloc(ring, &(struct fd_reloc){
 157                 .bo = bo,
 158                 .flags = FD_RELOC_READ,
 159                 .offset = offset,
 160                 .or = or,
 161                 .shift = shift,
 162         });
 163 }
 164
 165 static inline void
 166 OUT_RELOCW(struct fd_ringbuffer *ring, struct fd_bo *bo,
 167                 uint32_t offset, uint32_t or, int32_t shift)
 168 {
 169         if (LOG_DWORDS) {
 170                 DBG("ring[%p]: OUT_RELOCW  %04x:  %p+%u << %d", ring,
 171                                 (uint32_t)(ring->cur - ring->last_start), bo, offset, shift);
 172         }
 173         fd_ringbuffer_reloc(ring, &(struct fd_reloc){
 174                 .bo = bo,
 175                 .flags = FD_RELOC_READ | FD_RELOC_WRITE,
 176                 .offset = offset,
 177                 .or = or,
 178                 .shift = shift,
 179         });
 180 }
 181
 182 static inline void BEGIN_RING(struct fd_ringbuffer *ring, uint32_t ndwords)
 183 {
 184         if ((ring->cur + ndwords) >= ring->end) {
 185                 /* this probably won't really work if we have multiple tiles..
 186                  * but it is ok for 2d..  we might need different behavior
 187                  * depending on 2d or 3d pipe.
 188                  */
 189                 DBG("uh oh..");
 190         }
 191 }
 192
 193 static inline void
 194 OUT_PKT0(struct fd_ringbuffer *ring, uint16_t regindx, uint16_t cnt)
 195 {
 196         BEGIN_RING(ring, cnt+1);
 197         OUT_RING(ring, CP_TYPE0_PKT | ((cnt-1) << 16) | (regindx & 0x7FFF));
 198 }
 199
 200 static inline void
 201 OUT_PKT3(struct fd_ringbuffer *ring, uint8_t opcode, uint16_t cnt)
 202 {
 203         BEGIN_RING(ring, cnt+1);
 204         OUT_RING(ring, CP_TYPE3_PKT | ((cnt-1) << 16) | ((opcode & 0xFF) << 8));
 205 }
 206
 207 static inline void
 208 OUT_WFI(struct fd_ringbuffer *ring)
 209 {
 210         OUT_PKT3(ring, CP_WAIT_FOR_IDLE, 1);
 211         OUT_RING(ring, 0x00000000);
 212 }
 213
 214 static inline void
 215 OUT_IB(struct fd_ringbuffer *ring, struct fd_ringmarker *start,
 216                 struct fd_ringmarker *end)
 217 {
 218         uint32_t dwords = fd_ringmarker_dwords(start, end);
 219
 220         assert(dwords > 0);
 221
 222         /* for debug after a lock up, write a unique counter value
 223          * to scratch6 for each IB, to make it easier to match up
 224          * register dumps to cmdstream.  The combination of IB and
 225          * DRAW (scratch7) is enough to "triangulate" the particular
 226          * draw that caused lockup.
 227          */
 228         emit_marker(ring, 6);
 229
 230         OUT_PKT3(ring, CP_INDIRECT_BUFFER_PFD, 2);
 231         fd_ringbuffer_emit_reloc_ring(ring, start, end);
 232         OUT_RING(ring, dwords);
 233
 234         emit_marker(ring, 6);
 235 }
 236
 237 /* CP_SCRATCH_REG4 is used to hold base address for query results: */
 238 #define HW_QUERY_BASE_REG REG_AXXX_CP_SCRATCH_REG4
 239
 240 static inline void
 241 emit_marker(struct fd_ringbuffer *ring, int scratch_idx)
 242 {
 243         extern unsigned marker_cnt;
 244         unsigned reg = REG_AXXX_CP_SCRATCH_REG0 + scratch_idx;
 245         assert(reg != HW_QUERY_BASE_REG);
 246         if (reg == HW_QUERY_BASE_REG)
 247                 return;
 248         OUT_PKT0(ring, reg, 1);
 249         OUT_RING(ring, ++marker_cnt);
 250 }
 251
 252 /* helper to get numeric value from environment variable..  mostly
 253  * just leaving this here because it is helpful to brute-force figure
 254  * out unknown formats, etc, which blob driver does not support:
 255  */
 256 static inline uint32_t env2u(const char *envvar)
 257 {
 258         char *str = getenv(envvar);
 259         if (str)
 260                 return strtoul(str, NULL, 0);
 261         return 0;
 262 }
 263
 264 static inline uint32_t
 265 pack_rgba(enum pipe_format format, const float *rgba)
 266 {
 267         union util_color uc;
 268         util_pack_color(rgba, format, &uc);
 269         return uc.ui[0];
 270 }
 271
 272 #endif /* FREEDRENO_UTIL_H_ */