1/*
2 * Copyright © 2019 Intel Corporation
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 shall be included
12 * in all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21 */
22
23/**
24 * Macro and function definitions needed in order to use genxml.
25 *
26 * This should only be included in sources compiled per-generation.
27 */
28
29#include "crocus_batch.h"
30
31#include "genxml/gen_macros.h"
32
33#define __gen_address_type struct crocus_address
34#define __gen_user_data struct crocus_batch
35#define __gen_combine_address crocus_combine_address
36
37static inline void *
38__gen_get_batch_dwords(struct crocus_batch *batch, unsigned dwords)
39{
40   return crocus_get_command_space(batch, dwords * sizeof(uint32_t));
41}
42
43static inline struct crocus_address
44__gen_address_offset(struct crocus_address addr, uint64_t offset)
45{
46   addr.offset += offset;
47   return addr;
48}
49
50static uint64_t
51__gen_combine_address(struct crocus_batch *batch, void *location,
52                      struct crocus_address addr, uint32_t delta)
53{
54   uint32_t offset = (char *)location - (char *)batch->command.map;
55
56   if (addr.bo == NULL) {
57      return addr.offset + delta;
58   } else {
59      if (GFX_VER < 6 && crocus_ptr_in_state_buffer(batch, location)) {
60         offset = (char *) location - (char *) batch->state.map;
61         return crocus_state_reloc(batch, offset, addr.bo,
62                                   addr.offset + delta,
63                                   addr.reloc_flags);
64      }
65
66      assert(!crocus_ptr_in_state_buffer(batch, location));
67
68      offset = (char *) location - (char *) batch->command.map;
69      return crocus_command_reloc(batch, offset, addr.bo,
70                                  addr.offset + delta,
71                                  addr.reloc_flags);
72   }
73}
74
75#define __gen_address_type struct crocus_address
76#define __gen_user_data struct crocus_batch
77
78#define __genxml_cmd_length(cmd) cmd ## _length
79#define __genxml_cmd_length_bias(cmd) cmd ## _length_bias
80#define __genxml_cmd_header(cmd) cmd ## _header
81#define __genxml_cmd_pack(cmd) cmd ## _pack
82#define __genxml_reg_num(cmd) cmd ## _num
83
84#include "genxml/genX_pack.h"
85#include "genxml/gen_macros.h"
86#include "genxml/genX_bits.h"
87
88/* CS_GPR(15) is reserved for combining conditional rendering predicates
89 * with GL_ARB_indirect_parameters draw number predicates.
90 */
91#define MI_BUILDER_NUM_ALLOC_GPRS 15
92#include "common/mi_builder.h"
93
94#define _crocus_pack_command(batch, cmd, dst, name)                 \
95   for (struct cmd name = { __genxml_cmd_header(cmd) },           \
96        *_dst = (void *)(dst); __builtin_expect(_dst != NULL, 1); \
97        ({ __genxml_cmd_pack(cmd)(batch, (void *)_dst, &name);    \
98           _dst = NULL;                                           \
99           }))
100
101#define crocus_pack_command(cmd, dst, name) \
102   _crocus_pack_command(NULL, cmd, dst, name)
103
104#define _crocus_pack_state(batch, cmd, dst, name)                   \
105   for (struct cmd name = {},                                     \
106        *_dst = (void *)(dst); __builtin_expect(_dst != NULL, 1); \
107        __genxml_cmd_pack(cmd)(batch, (void *)_dst, &name),       \
108        _dst = NULL)
109
110#define crocus_pack_state(cmd, dst, name)                           \
111   _crocus_pack_state(NULL, cmd, dst, name)
112
113#define crocus_emit_cmd(batch, cmd, name) \
114   _crocus_pack_command(batch, cmd, __gen_get_batch_dwords(batch, __genxml_cmd_length(cmd)), name)
115
116#define crocus_emit_merge(batch, dwords0, dwords1, num_dwords)    \
117   do {                                                         \
118      uint32_t *dw = __gen_get_batch_dwords(batch, num_dwords); \
119      for (uint32_t i = 0; i < num_dwords; i++)                 \
120         dw[i] = (dwords0)[i] | (dwords1)[i];                   \
121      VG(VALGRIND_CHECK_MEM_IS_DEFINED(dw, num_dwords));        \
122   } while (0)
123
124#define crocus_emit_reg(batch, reg, name)                                 \
125   for (struct reg name = {}, *_cont = (struct reg *)1; _cont != NULL;  \
126        ({                                                              \
127            uint32_t _dw[__genxml_cmd_length(reg)];                     \
128            __genxml_cmd_pack(reg)(NULL, _dw, &name);                   \
129            for (unsigned i = 0; i < __genxml_cmd_length(reg); i++) {   \
130               crocus_emit_cmd(batch, GENX(MI_LOAD_REGISTER_IMM), lri) {  \
131                  lri.RegisterOffset   = __genxml_reg_num(reg);         \
132                  lri.DataDWord        = _dw[i];                        \
133               }                                                        \
134            }                                                           \
135           _cont = NULL;                                                \
136         }))
137
138
139/**
140 * crocus_address constructor helpers:
141 *
142 * When using these to construct a CSO, pass NULL for \p bo, and manually
143 * pin the BO later.  Otherwise, genxml's address handling will add the
144 * BO to the current batch's validation list at CSO creation time, rather
145 * than at draw time as desired.
146 */
147
148UNUSED static struct crocus_address
149ro_bo(struct crocus_bo *bo, uint64_t offset)
150{
151   return (struct crocus_address) { .bo = bo, .offset = offset, .reloc_flags = RELOC_32BIT };
152}
153
154UNUSED static struct crocus_address
155rw_bo(struct crocus_bo *bo, uint64_t offset)
156{
157   return (struct crocus_address) { .bo = bo, .offset = offset, .reloc_flags = RELOC_32BIT | RELOC_WRITE };
158}
159
160UNUSED static struct crocus_address
161ggtt_bo(struct crocus_bo *bo, uint64_t offset)
162{
163   return (struct crocus_address) { .bo = bo, .offset = offset, .reloc_flags = RELOC_WRITE | RELOC_NEEDS_GGTT };
164}
165