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 "adreno_common.xml.h"
  44 #include "adreno_pm4.xml.h"
  45
  46 enum adreno_rb_depth_format fd_pipe2depth(enum pipe_format format);
  47 enum pc_di_index_size fd_pipe2index(enum pipe_format format);
  48 enum adreno_rb_blend_factor fd_blend_factor(unsigned factor);
  49 enum adreno_pa_su_sc_draw fd_polygon_mode(unsigned mode);
  50 enum adreno_stencil_op fd_stencil_op(unsigned op);
  51
  52 #define A3XX_MAX_MIP_LEVELS 14
  53 /* TBD if it is same on a2xx, but for now: */
  54 #define MAX_MIP_LEVELS A3XX_MAX_MIP_LEVELS
  55
  56 #define FD_DBG_MSGS     0x0001
  57 #define FD_DBG_DISASM   0x0002
  58 #define FD_DBG_DCLEAR   0x0004
  59 #define FD_DBG_FLUSH    0x0008
  60 #define FD_DBG_NOSCIS   0x0010
  61 #define FD_DBG_DIRECT   0x0020
  62 #define FD_DBG_NOBYPASS 0x0040
  63 #define FD_DBG_FRAGHALF 0x0080
  64 #define FD_DBG_NOBIN    0x0100
  65 #define FD_DBG_OPTMSGS  0x0400
  66 #define FD_DBG_OPTDUMP  0x0800
  67 #define FD_DBG_GLSL120  0x1000
  68 #define FD_DBG_NOCP     0x2000
  69 #define FD_DBG_NIR      0x4000
  70
  71 extern int fd_mesa_debug;
  72 extern bool fd_binning_enabled;
  73
  74 #define DBG(fmt, ...) \
  75                 do { if (fd_mesa_debug & FD_DBG_MSGS) \
  76                         debug_printf("%s:%d: "fmt "\n", \
  77                                 __FUNCTION__, __LINE__, ##__VA_ARGS__); } while (0)
  78
  79 /* for conditionally setting boolean flag(s): */
  80 #define COND(bool, val) ((bool) ? (val) : 0)
  81
  82 #define CP_REG(reg) ((0x4 << 16) | ((unsigned int)((reg) - (0x2000))))
  83
  84 static inline uint32_t DRAW(enum pc_di_primtype prim_type,
  85                 enum pc_di_src_sel source_select, enum pc_di_index_size index_size,
  86                 enum pc_di_vis_cull_mode vis_cull_mode,
  87                 uint8_t instances)
  88 {
  89         return (prim_type         << 0) |
  90                         (source_select     << 6) |
  91                         ((index_size & 1)  << 11) |
  92                         ((index_size >> 1) << 13) |
  93                         (vis_cull_mode     << 9) |
  94                         (1                 << 14) |
  95                         (instances         << 24);
  96 }
  97
  98 /* for tracking cmdstream positions that need to be patched: */
  99 struct fd_cs_patch {
 100         uint32_t *cs;
 101         uint32_t val;
 102 };
 103 #define fd_patch_num_elements(buf) ((buf)->size / sizeof(struct fd_cs_patch))
 104 #define fd_patch_element(buf, i)   util_dynarray_element(buf, struct fd_cs_patch, i)
 105
 106 static inline enum pipe_format
 107 pipe_surface_format(struct pipe_surface *psurf)
 108 {
 109         if (!psurf)
 110                 return PIPE_FORMAT_NONE;
 111         return psurf->format;
 112 }
 113
 114 #define LOG_DWORDS 0
 115
 116 static inline void emit_marker(struct fd_ringbuffer *ring, int scratch_idx);
 117
 118 static inline void
 119 OUT_RING(struct fd_ringbuffer *ring, uint32_t data)
 120 {
 121         if (LOG_DWORDS) {
 122                 DBG("ring[%p]: OUT_RING   %04x:  %08x", ring,
 123                                 (uint32_t)(ring->cur - ring->last_start), data);
 124         }
 125         *(ring->cur++) = data;
 126 }
 127
 128 /* like OUT_RING() but appends a cmdstream patch point to 'buf' */
 129 static inline void
 130 OUT_RINGP(struct fd_ringbuffer *ring, uint32_t data,
 131                 struct util_dynarray *buf)
 132 {
 133         if (LOG_DWORDS) {
 134                 DBG("ring[%p]: OUT_RINGP  %04x:  %08x", ring,
 135                                 (uint32_t)(ring->cur - ring->last_start), data);
 136         }
 137         util_dynarray_append(buf, struct fd_cs_patch, ((struct fd_cs_patch){
 138                 .cs  = ring->cur++,
 139                 .val = data,
 140         }));
 141 }
 142
 143 static inline void
 144 OUT_RELOC(struct fd_ringbuffer *ring, struct fd_bo *bo,
 145                 uint32_t offset, uint32_t or, int32_t shift)
 146 {
 147         if (LOG_DWORDS) {
 148                 DBG("ring[%p]: OUT_RELOC   %04x:  %p+%u << %d", ring,
 149                                 (uint32_t)(ring->cur - ring->last_start), bo, offset, shift);
 150         }
 151         fd_ringbuffer_reloc(ring, &(struct fd_reloc){
 152                 .bo = bo,
 153                 .flags = FD_RELOC_READ,
 154                 .offset = offset,
 155                 .or = or,
 156                 .shift = shift,
 157         });
 158 }
 159
 160 static inline void
 161 OUT_RELOCW(struct fd_ringbuffer *ring, struct fd_bo *bo,
 162                 uint32_t offset, uint32_t or, int32_t shift)
 163 {
 164         if (LOG_DWORDS) {
 165                 DBG("ring[%p]: OUT_RELOCW  %04x:  %p+%u << %d", ring,
 166                                 (uint32_t)(ring->cur - ring->last_start), bo, offset, shift);
 167         }
 168         fd_ringbuffer_reloc(ring, &(struct fd_reloc){
 169                 .bo = bo,
 170                 .flags = FD_RELOC_READ | FD_RELOC_WRITE,
 171                 .offset = offset,
 172                 .or = or,
 173                 .shift = shift,
 174         });
 175 }
 176
 177 static inline void BEGIN_RING(struct fd_ringbuffer *ring, uint32_t ndwords)
 178 {
 179         if ((ring->cur + ndwords) >= ring->end) {
 180                 /* this probably won't really work if we have multiple tiles..
 181                  * but it is ok for 2d..  we might need different behavior
 182                  * depending on 2d or 3d pipe.
 183                  */
 184                 DBG("uh oh..");
 185         }
 186 }
 187
 188 static inline void
 189 OUT_PKT0(struct fd_ringbuffer *ring, uint16_t regindx, uint16_t cnt)
 190 {
 191         BEGIN_RING(ring, cnt+1);
 192         OUT_RING(ring, CP_TYPE0_PKT | ((cnt-1) << 16) | (regindx & 0x7FFF));
 193 }
 194
 195 static inline void
 196 OUT_PKT3(struct fd_ringbuffer *ring, uint8_t opcode, uint16_t cnt)
 197 {
 198         BEGIN_RING(ring, cnt+1);
 199         OUT_RING(ring, CP_TYPE3_PKT | ((cnt-1) << 16) | ((opcode & 0xFF) << 8));
 200 }
 201
 202 static inline void
 203 OUT_WFI(struct fd_ringbuffer *ring)
 204 {
 205         OUT_PKT3(ring, CP_WAIT_FOR_IDLE, 1);
 206         OUT_RING(ring, 0x00000000);
 207 }
 208
 209 static inline void
 210 OUT_IB(struct fd_ringbuffer *ring, struct fd_ringmarker *start,
 211                 struct fd_ringmarker *end)
 212 {
 213         uint32_t dwords = fd_ringmarker_dwords(start, end);
 214
 215         assert(dwords > 0);
 216
 217         /* for debug after a lock up, write a unique counter value
 218          * to scratch6 for each IB, to make it easier to match up
 219          * register dumps to cmdstream.  The combination of IB and
 220          * DRAW (scratch7) is enough to "triangulate" the particular
 221          * draw that caused lockup.
 222          */
 223         emit_marker(ring, 6);
 224
 225         OUT_PKT3(ring, CP_INDIRECT_BUFFER_PFD, 2);
 226         fd_ringbuffer_emit_reloc_ring(ring, start, end);
 227         OUT_RING(ring, dwords);
 228
 229         emit_marker(ring, 6);
 230 }
 231
 232 /* CP_SCRATCH_REG4 is used to hold base address for query results: */
 233 #define HW_QUERY_BASE_REG REG_AXXX_CP_SCRATCH_REG4
 234
 235 static inline void
 236 emit_marker(struct fd_ringbuffer *ring, int scratch_idx)
 237 {
 238         extern unsigned marker_cnt;
 239         unsigned reg = REG_AXXX_CP_SCRATCH_REG0 + scratch_idx;
 240         assert(reg != HW_QUERY_BASE_REG);
 241         if (reg == HW_QUERY_BASE_REG)
 242                 return;
 243         OUT_PKT0(ring, reg, 1);
 244         OUT_RING(ring, ++marker_cnt);
 245 }
 246
 247 /* helper to get numeric value from environment variable..  mostly
 248  * just leaving this here because it is helpful to brute-force figure
 249  * out unknown formats, etc, which blob driver does not support:
 250  */
 251 static inline uint32_t env2u(const char *envvar)
 252 {
 253         char *str = getenv(envvar);
 254         if (str)
 255                 return strtoul(str, NULL, 0);
 256         return 0;
 257 }
 258
 259 static inline uint32_t
 260 pack_rgba(enum pipe_format format, const float *rgba)
 261 {
 262         union util_color uc;
 263         util_pack_color(rgba, format, &uc);
 264         return uc.ui[0];
 265 }
 266
 267 #endif /* FREEDRENO_UTIL_H_ */