intel/isl: Add an isl_assert_div helper
[mesa.git] / src / intel / isl / isl_priv.h
1 /*
2 * Copyright 2015 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 (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 DEALINGS
21 * IN THE SOFTWARE.
22 */
23
24 #ifndef ISL_PRIV_H
25 #define ISL_PRIV_H
26
27 #include <assert.h>
28 #include <strings.h>
29
30 #include "common/gen_device_info.h"
31 #include "util/macros.h"
32
33 #include "isl.h"
34
35 #define isl_finishme(format, ...) \
36 do { \
37 static bool reported = false; \
38 if (!reported) { \
39 __isl_finishme(__FILE__, __LINE__, format, ##__VA_ARGS__); \
40 reported = true; \
41 } \
42 } while (0)
43
44 void PRINTFLIKE(3, 4) UNUSED
45 __isl_finishme(const char *file, int line, const char *fmt, ...);
46
47 #define MIN(a, b) ((a) < (b) ? (a) : (b))
48 #define MAX(a, b) ((a) > (b) ? (a) : (b))
49
50 static inline bool
51 isl_is_pow2(uintmax_t n)
52 {
53 return !(n & (n - 1));
54 }
55
56 /**
57 * Alignment must be a power of 2.
58 */
59 static inline bool
60 isl_is_aligned(uintmax_t n, uintmax_t a)
61 {
62 assert(isl_is_pow2(a));
63 return (n & (a - 1)) == 0;
64 }
65
66 /**
67 * Alignment must be a power of 2.
68 */
69 static inline uintmax_t
70 isl_align(uintmax_t n, uintmax_t a)
71 {
72 assert(a != 0 && isl_is_pow2(a));
73 return (n + a - 1) & ~(a - 1);
74 }
75
76 static inline uintmax_t
77 isl_align_npot(uintmax_t n, uintmax_t a)
78 {
79 assert(a > 0);
80 return ((n + a - 1) / a) * a;
81 }
82
83 static inline uintmax_t
84 isl_assert_div(uintmax_t n, uintmax_t a)
85 {
86 assert(n % a == 0);
87 return n / a;
88 }
89
90 /**
91 * Alignment must be a power of 2.
92 */
93 static inline uintmax_t
94 isl_align_div(uintmax_t n, uintmax_t a)
95 {
96 return isl_align(n, a) / a;
97 }
98
99 static inline uintmax_t
100 isl_align_div_npot(uintmax_t n, uintmax_t a)
101 {
102 return isl_align_npot(n, a) / a;
103 }
104
105 /**
106 * Log base 2, rounding towards zero.
107 */
108 static inline uint32_t
109 isl_log2u(uint32_t n)
110 {
111 assert(n != 0);
112 return 31 - __builtin_clz(n);
113 }
114
115 static inline uint32_t
116 isl_round_up_to_power_of_two(uint32_t value)
117 {
118 if (value <= 1)
119 return value;
120
121 return 1 << (32 - __builtin_clz(value - 1));
122 }
123
124 static inline uint32_t
125 isl_minify(uint32_t n, uint32_t levels)
126 {
127 if (unlikely(n == 0))
128 return 0;
129 else
130 return MAX(n >> levels, 1);
131 }
132
133 static inline struct isl_extent3d
134 isl_extent3d_sa_to_el(enum isl_format fmt, struct isl_extent3d extent_sa)
135 {
136 const struct isl_format_layout *fmtl = isl_format_get_layout(fmt);
137
138 assert(extent_sa.w % fmtl->bw == 0);
139 assert(extent_sa.h % fmtl->bh == 0);
140 assert(extent_sa.d % fmtl->bd == 0);
141
142 return (struct isl_extent3d) {
143 .w = extent_sa.w / fmtl->bw,
144 .h = extent_sa.h / fmtl->bh,
145 .d = extent_sa.d / fmtl->bd,
146 };
147 }
148
149 static inline struct isl_extent3d
150 isl_extent3d_el_to_sa(enum isl_format fmt, struct isl_extent3d extent_el)
151 {
152 const struct isl_format_layout *fmtl = isl_format_get_layout(fmt);
153
154 return (struct isl_extent3d) {
155 .w = extent_el.w * fmtl->bw,
156 .h = extent_el.h * fmtl->bh,
157 .d = extent_el.d * fmtl->bd,
158 };
159 }
160
161 void
162 isl_gen4_surf_fill_state_s(const struct isl_device *dev, void *state,
163 const struct isl_surf_fill_state_info *restrict info);
164
165 void
166 isl_gen5_surf_fill_state_s(const struct isl_device *dev, void *state,
167 const struct isl_surf_fill_state_info *restrict info);
168
169 void
170 isl_gen6_surf_fill_state_s(const struct isl_device *dev, void *state,
171 const struct isl_surf_fill_state_info *restrict info);
172
173 void
174 isl_gen7_surf_fill_state_s(const struct isl_device *dev, void *state,
175 const struct isl_surf_fill_state_info *restrict info);
176
177 void
178 isl_gen75_surf_fill_state_s(const struct isl_device *dev, void *state,
179 const struct isl_surf_fill_state_info *restrict info);
180 void
181 isl_gen8_surf_fill_state_s(const struct isl_device *dev, void *state,
182 const struct isl_surf_fill_state_info *restrict info);
183 void
184 isl_gen9_surf_fill_state_s(const struct isl_device *dev, void *state,
185 const struct isl_surf_fill_state_info *restrict info);
186
187 void
188 isl_gen4_buffer_fill_state_s(void *state,
189 const struct isl_buffer_fill_state_info *restrict info);
190
191 void
192 isl_gen5_buffer_fill_state_s(void *state,
193 const struct isl_buffer_fill_state_info *restrict info);
194
195 void
196 isl_gen6_buffer_fill_state_s(void *state,
197 const struct isl_buffer_fill_state_info *restrict info);
198
199 void
200 isl_gen7_buffer_fill_state_s(void *state,
201 const struct isl_buffer_fill_state_info *restrict info);
202
203 void
204 isl_gen75_buffer_fill_state_s(void *state,
205 const struct isl_buffer_fill_state_info *restrict info);
206
207 void
208 isl_gen8_buffer_fill_state_s(void *state,
209 const struct isl_buffer_fill_state_info *restrict info);
210
211 void
212 isl_gen9_buffer_fill_state_s(void *state,
213 const struct isl_buffer_fill_state_info *restrict info);
214
215 void
216 isl_gen4_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
217 const struct isl_depth_stencil_hiz_emit_info *restrict info);
218
219 void
220 isl_gen5_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
221 const struct isl_depth_stencil_hiz_emit_info *restrict info);
222
223 void
224 isl_gen6_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
225 const struct isl_depth_stencil_hiz_emit_info *restrict info);
226
227 void
228 isl_gen7_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
229 const struct isl_depth_stencil_hiz_emit_info *restrict info);
230
231 void
232 isl_gen75_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
233 const struct isl_depth_stencil_hiz_emit_info *restrict info);
234
235 void
236 isl_gen8_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
237 const struct isl_depth_stencil_hiz_emit_info *restrict info);
238
239 void
240 isl_gen9_emit_depth_stencil_hiz_s(const struct isl_device *dev, void *batch,
241 const struct isl_depth_stencil_hiz_emit_info *restrict info);
242
243 #endif /* ISL_PRIV_H */