src/freedreno/vulkan/tu_cs.h

   1 /*
   2  * Copyright © 2019 Google LLC
   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  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23 #ifndef TU_CS_H
  24 #define TU_CS_H
  25
  26 #include "tu_private.h"
  27
  28 #include "registers/adreno_pm4.xml.h"
  29
  30 void
  31 tu_cs_init(struct tu_cs *cs, uint32_t initial_size);
  32
  33 void
  34 tu_cs_finish(struct tu_device *dev, struct tu_cs *cs);
  35
  36 void
  37 tu_cs_begin(struct tu_cs *cs);
  38
  39 void
  40 tu_cs_end(struct tu_cs *cs);
  41
  42 VkResult
  43 tu_cs_reserve_space(struct tu_device *dev,
  44                     struct tu_cs *cs,
  45                     uint32_t reserved_size);
  46
  47 void
  48 tu_cs_reset(struct tu_device *dev, struct tu_cs *cs);
  49
  50 /**
  51  * Get the size needed for tu_cs_emit_call.
  52  */
  53 static inline uint32_t
  54 tu_cs_get_call_size(const struct tu_cs *cs)
  55 {
  56    /* each CP_INDIRECT_BUFFER needs 4 dwords */
  57    return cs->entry_count * 4;
  58 }
  59
  60 /**
  61  * Assert that we did not exceed the reserved space.
  62  */
  63 static inline void
  64 tu_cs_sanity_check(const struct tu_cs *cs)
  65 {
  66    assert(cs->start <= cs->cur);
  67    assert(cs->cur <= cs->reserved_end);
  68    assert(cs->reserved_end <= cs->end);
  69 }
  70
  71 /**
  72  * Emit a uint32_t value into a command stream, without boundary checking.
  73  */
  74 static inline void
  75 tu_cs_emit(struct tu_cs *cs, uint32_t value)
  76 {
  77    assert(cs->cur < cs->end);
  78    *cs->cur = value;
  79    ++cs->cur;
  80 }
  81
  82 static inline unsigned
  83 tu_odd_parity_bit(unsigned val)
  84 {
  85    /* See: http://graphics.stanford.edu/~seander/bithacks.html#ParityParallel
  86     * note that we want odd parity so 0x6996 is inverted.
  87     */
  88    val ^= val >> 16;
  89    val ^= val >> 8;
  90    val ^= val >> 4;
  91    val &= 0xf;
  92    return (~0x6996 >> val) & 1;
  93 }
  94
  95 /**
  96  * Emit a type-4 command packet header into a command stream.
  97  */
  98 static inline void
  99 tu_cs_emit_pkt4(struct tu_cs *cs, uint16_t regindx, uint16_t cnt)
 100 {
 101    tu_cs_emit(cs, CP_TYPE4_PKT | cnt | (tu_odd_parity_bit(cnt) << 7) |
 102                      ((regindx & 0x3ffff) << 8) |
 103                      ((tu_odd_parity_bit(regindx) << 27)));
 104 }
 105
 106 /**
 107  * Emit a type-7 command packet header into a command stream.
 108  */
 109 static inline void
 110 tu_cs_emit_pkt7(struct tu_cs *cs, uint8_t opcode, uint16_t cnt)
 111 {
 112    tu_cs_emit(cs, CP_TYPE7_PKT | cnt | (tu_odd_parity_bit(cnt) << 15) |
 113                      ((opcode & 0x7f) << 16) |
 114                      ((tu_odd_parity_bit(opcode) << 23)));
 115 }
 116
 117 static inline void
 118 tu_cs_emit_wfi(struct tu_cs *cs)
 119 {
 120    tu_cs_emit_pkt7(cs, CP_WAIT_FOR_IDLE, 0);
 121 }
 122
 123 static inline void
 124 tu_cs_emit_qw(struct tu_cs *cs, uint64_t value)
 125 {
 126    tu_cs_emit(cs, (uint32_t) value);
 127    tu_cs_emit(cs, (uint32_t) (value >> 32));
 128 }
 129
 130 static inline void
 131 tu_cs_emit_write_reg(struct tu_cs *cs, uint16_t reg, uint32_t value)
 132 {
 133    tu_cs_emit_pkt4(cs, reg, 1);
 134    tu_cs_emit(cs, value);
 135 }
 136
 137 /**
 138  * Emit a CP_INDIRECT_BUFFER command packet.
 139  */
 140 static inline void
 141 tu_cs_emit_ib(struct tu_cs *cs, const struct tu_cs_entry *entry)
 142 {
 143    assert(entry->offset % sizeof(uint32_t) == 0);
 144    assert(entry->size % sizeof(uint32_t) == 0);
 145
 146    tu_cs_emit_pkt7(cs, CP_INDIRECT_BUFFER, 3);
 147    tu_cs_emit_qw(cs, entry->bo->iova + entry->offset);
 148    tu_cs_emit(cs, entry->size / sizeof(uint32_t));
 149 }
 150
 151 /**
 152  * Emit a CP_INDIRECT_BUFFER command packet for each entry in the target
 153  * command stream.
 154  */
 155 static inline void
 156 tu_cs_emit_call(struct tu_cs *cs, const struct tu_cs *target)
 157 {
 158    for (uint32_t i = 0; i < target->entry_count; i++)
 159       tu_cs_emit_ib(cs, target->entries + i);
 160 }
 161
 162 #endif /* TU_CS_H */