1*61046927SAndroid Build Coastguard Worker /*
2*61046927SAndroid Build Coastguard Worker * Copyright (C) 2023 Collabora, Ltd.
3*61046927SAndroid Build Coastguard Worker *
4*61046927SAndroid Build Coastguard Worker * Permission is hereby granted, free of charge, to any person obtaining a
5*61046927SAndroid Build Coastguard Worker * copy of this software and associated documentation files (the "Software"),
6*61046927SAndroid Build Coastguard Worker * to deal in the Software without restriction, including without limitation
7*61046927SAndroid Build Coastguard Worker * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8*61046927SAndroid Build Coastguard Worker * and/or sell copies of the Software, and to permit persons to whom the
9*61046927SAndroid Build Coastguard Worker * Software is furnished to do so, subject to the following conditions:
10*61046927SAndroid Build Coastguard Worker *
11*61046927SAndroid Build Coastguard Worker * The above copyright notice and this permission notice (including the next
12*61046927SAndroid Build Coastguard Worker * paragraph) shall be included in all copies or substantial portions of the
13*61046927SAndroid Build Coastguard Worker * Software.
14*61046927SAndroid Build Coastguard Worker *
15*61046927SAndroid Build Coastguard Worker * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16*61046927SAndroid Build Coastguard Worker * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17*61046927SAndroid Build Coastguard Worker * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18*61046927SAndroid Build Coastguard Worker * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19*61046927SAndroid Build Coastguard Worker * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20*61046927SAndroid Build Coastguard Worker * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21*61046927SAndroid Build Coastguard Worker * SOFTWARE.
22*61046927SAndroid Build Coastguard Worker *
23*61046927SAndroid Build Coastguard Worker * Authors:
24*61046927SAndroid Build Coastguard Worker * Louis-Francis Ratté-Boulianne <[email protected]>
25*61046927SAndroid Build Coastguard Worker */
26*61046927SAndroid Build Coastguard Worker
27*61046927SAndroid Build Coastguard Worker #include "pan_texture.h"
28*61046927SAndroid Build Coastguard Worker
29*61046927SAndroid Build Coastguard Worker /* Arm Fixed-Rate Compression (AFRC) is a lossy compression scheme natively
30*61046927SAndroid Build Coastguard Worker * implemented in Mali GPUs. AFRC images can only be rendered or textured
31*61046927SAndroid Build Coastguard Worker * from. It is currently not possible to do image reads or writes to such
32*61046927SAndroid Build Coastguard Worker * resources.
33*61046927SAndroid Build Coastguard Worker *
34*61046927SAndroid Build Coastguard Worker * AFRC divides the image into an array of fixed-size coding units which are
35*61046927SAndroid Build Coastguard Worker * grouped into paging tiles. The size of the coding units (clump size)
36*61046927SAndroid Build Coastguard Worker * depends on the image format and the pixel layout (whether it is optimized
37*61046927SAndroid Build Coastguard Worker * for 2D locality and rotation, or for scan line order access). The last
38*61046927SAndroid Build Coastguard Worker * parameter is the size of the compressed block that can be either 16, 24,
39*61046927SAndroid Build Coastguard Worker * or 32 bytes.
40*61046927SAndroid Build Coastguard Worker *
41*61046927SAndroid Build Coastguard Worker * The compression rate can be calculated by dividing the compressed block
42*61046927SAndroid Build Coastguard Worker * size by the uncompressed block size (clump size multiplied by the component
43*61046927SAndroid Build Coastguard Worker * size and the number of components).
44*61046927SAndroid Build Coastguard Worker */
45*61046927SAndroid Build Coastguard Worker
46*61046927SAndroid Build Coastguard Worker struct pan_afrc_format_info
panfrost_afrc_get_format_info(enum pipe_format format)47*61046927SAndroid Build Coastguard Worker panfrost_afrc_get_format_info(enum pipe_format format)
48*61046927SAndroid Build Coastguard Worker {
49*61046927SAndroid Build Coastguard Worker const struct util_format_description *desc = util_format_description(format);
50*61046927SAndroid Build Coastguard Worker struct pan_afrc_format_info info = {0};
51*61046927SAndroid Build Coastguard Worker
52*61046927SAndroid Build Coastguard Worker /* No AFRC(ZS). */
53*61046927SAndroid Build Coastguard Worker if (desc->colorspace == UTIL_FORMAT_COLORSPACE_ZS)
54*61046927SAndroid Build Coastguard Worker return info;
55*61046927SAndroid Build Coastguard Worker
56*61046927SAndroid Build Coastguard Worker unsigned bpc = 0;
57*61046927SAndroid Build Coastguard Worker for (unsigned c = 0; c < desc->nr_channels; c++) {
58*61046927SAndroid Build Coastguard Worker if (bpc && bpc != desc->channel[c].size)
59*61046927SAndroid Build Coastguard Worker return info;
60*61046927SAndroid Build Coastguard Worker
61*61046927SAndroid Build Coastguard Worker bpc = desc->channel[0].size;
62*61046927SAndroid Build Coastguard Worker }
63*61046927SAndroid Build Coastguard Worker
64*61046927SAndroid Build Coastguard Worker info.bpc = bpc;
65*61046927SAndroid Build Coastguard Worker
66*61046927SAndroid Build Coastguard Worker if (desc->colorspace == UTIL_FORMAT_COLORSPACE_YUV) {
67*61046927SAndroid Build Coastguard Worker if (desc->layout != UTIL_FORMAT_LAYOUT_SUBSAMPLED)
68*61046927SAndroid Build Coastguard Worker info.ichange_fmt = PAN_AFRC_ICHANGE_FORMAT_YUV444;
69*61046927SAndroid Build Coastguard Worker else if (util_format_is_subsampled_422(format))
70*61046927SAndroid Build Coastguard Worker info.ichange_fmt = PAN_AFRC_ICHANGE_FORMAT_YUV422;
71*61046927SAndroid Build Coastguard Worker else
72*61046927SAndroid Build Coastguard Worker info.ichange_fmt = PAN_AFRC_ICHANGE_FORMAT_YUV420;
73*61046927SAndroid Build Coastguard Worker } else {
74*61046927SAndroid Build Coastguard Worker assert(desc->colorspace == UTIL_FORMAT_COLORSPACE_RGB ||
75*61046927SAndroid Build Coastguard Worker desc->colorspace == UTIL_FORMAT_COLORSPACE_SRGB);
76*61046927SAndroid Build Coastguard Worker info.ichange_fmt = PAN_AFRC_ICHANGE_FORMAT_RAW;
77*61046927SAndroid Build Coastguard Worker }
78*61046927SAndroid Build Coastguard Worker
79*61046927SAndroid Build Coastguard Worker info.num_planes = util_format_get_num_planes(format);
80*61046927SAndroid Build Coastguard Worker info.num_comps = util_format_get_nr_components(format);
81*61046927SAndroid Build Coastguard Worker return info;
82*61046927SAndroid Build Coastguard Worker }
83*61046927SAndroid Build Coastguard Worker
84*61046927SAndroid Build Coastguard Worker bool
panfrost_format_supports_afrc(enum pipe_format format)85*61046927SAndroid Build Coastguard Worker panfrost_format_supports_afrc(enum pipe_format format)
86*61046927SAndroid Build Coastguard Worker {
87*61046927SAndroid Build Coastguard Worker const struct util_format_description *desc = util_format_description(format);
88*61046927SAndroid Build Coastguard Worker int c = util_format_get_first_non_void_channel(desc->format);
89*61046927SAndroid Build Coastguard Worker
90*61046927SAndroid Build Coastguard Worker if (c == -1)
91*61046927SAndroid Build Coastguard Worker return false;
92*61046927SAndroid Build Coastguard Worker
93*61046927SAndroid Build Coastguard Worker return desc->is_array && desc->channel[c].size == 8;
94*61046927SAndroid Build Coastguard Worker }
95*61046927SAndroid Build Coastguard Worker
96*61046927SAndroid Build Coastguard Worker struct panfrost_afrc_block_size {
97*61046927SAndroid Build Coastguard Worker unsigned size; /* Block size in bytes */
98*61046927SAndroid Build Coastguard Worker unsigned alignment; /* Buffer alignment */
99*61046927SAndroid Build Coastguard Worker uint64_t modifier_flag; /* Part of the modifier for CU size */
100*61046927SAndroid Build Coastguard Worker };
101*61046927SAndroid Build Coastguard Worker
102*61046927SAndroid Build Coastguard Worker #define BLOCK_SIZE(block_size, buffer_alignment) \
103*61046927SAndroid Build Coastguard Worker { \
104*61046927SAndroid Build Coastguard Worker .size = block_size, .alignment = buffer_alignment, \
105*61046927SAndroid Build Coastguard Worker .modifier_flag = AFRC_FORMAT_MOD_CU_SIZE_##block_size, \
106*61046927SAndroid Build Coastguard Worker }
107*61046927SAndroid Build Coastguard Worker
108*61046927SAndroid Build Coastguard Worker /* clang-format off */
109*61046927SAndroid Build Coastguard Worker const struct panfrost_afrc_block_size panfrost_afrc_block_sizes[] = {
110*61046927SAndroid Build Coastguard Worker BLOCK_SIZE(16, 1024),
111*61046927SAndroid Build Coastguard Worker BLOCK_SIZE(24, 512),
112*61046927SAndroid Build Coastguard Worker BLOCK_SIZE(32, 2048),
113*61046927SAndroid Build Coastguard Worker };
114*61046927SAndroid Build Coastguard Worker /* clang-format on */
115*61046927SAndroid Build Coastguard Worker
116*61046927SAndroid Build Coastguard Worker /* Total number of components in a AFRC coding unit */
117*61046927SAndroid Build Coastguard Worker static unsigned
panfrost_afrc_clump_get_nr_components(enum pipe_format format,bool scan)118*61046927SAndroid Build Coastguard Worker panfrost_afrc_clump_get_nr_components(enum pipe_format format, bool scan)
119*61046927SAndroid Build Coastguard Worker {
120*61046927SAndroid Build Coastguard Worker const struct util_format_description *desc = util_format_description(format);
121*61046927SAndroid Build Coastguard Worker struct pan_block_size clump_sz = panfrost_afrc_clump_size(format, scan);
122*61046927SAndroid Build Coastguard Worker return clump_sz.width * clump_sz.height * desc->nr_channels;
123*61046927SAndroid Build Coastguard Worker }
124*61046927SAndroid Build Coastguard Worker
125*61046927SAndroid Build Coastguard Worker unsigned
panfrost_afrc_query_rates(enum pipe_format format,unsigned max,uint32_t * rates)126*61046927SAndroid Build Coastguard Worker panfrost_afrc_query_rates(enum pipe_format format, unsigned max,
127*61046927SAndroid Build Coastguard Worker uint32_t *rates)
128*61046927SAndroid Build Coastguard Worker {
129*61046927SAndroid Build Coastguard Worker if (!panfrost_format_supports_afrc(format))
130*61046927SAndroid Build Coastguard Worker return 0;
131*61046927SAndroid Build Coastguard Worker
132*61046927SAndroid Build Coastguard Worker unsigned clump_comps = panfrost_afrc_clump_get_nr_components(format, false);
133*61046927SAndroid Build Coastguard Worker unsigned nr_rates = 0;
134*61046927SAndroid Build Coastguard Worker
135*61046927SAndroid Build Coastguard Worker /**
136*61046927SAndroid Build Coastguard Worker * From EGL_EXT_surface_compression:
137*61046927SAndroid Build Coastguard Worker *
138*61046927SAndroid Build Coastguard Worker * "For pixel formats with different number of bits per component, the
139*61046927SAndroid Build Coastguard Worker * specified fixed-rate compression rate applies to the component with
140*61046927SAndroid Build Coastguard Worker * the highest number of bits."
141*61046927SAndroid Build Coastguard Worker *
142*61046927SAndroid Build Coastguard Worker * We only support formats where all components have the same size for now.
143*61046927SAndroid Build Coastguard Worker * Let's just use the first component size for calculation.
144*61046927SAndroid Build Coastguard Worker */
145*61046927SAndroid Build Coastguard Worker unsigned uncompressed_rate =
146*61046927SAndroid Build Coastguard Worker util_format_get_component_bits(format, UTIL_FORMAT_COLORSPACE_RGB, 0);
147*61046927SAndroid Build Coastguard Worker
148*61046927SAndroid Build Coastguard Worker for (unsigned i = 0; i < ARRAY_SIZE(panfrost_afrc_block_sizes); ++i) {
149*61046927SAndroid Build Coastguard Worker unsigned clump_sz = panfrost_afrc_block_sizes[i].size * 8;
150*61046927SAndroid Build Coastguard Worker unsigned rate = clump_sz / clump_comps;
151*61046927SAndroid Build Coastguard Worker
152*61046927SAndroid Build Coastguard Worker if (rate >= uncompressed_rate)
153*61046927SAndroid Build Coastguard Worker continue;
154*61046927SAndroid Build Coastguard Worker
155*61046927SAndroid Build Coastguard Worker if (nr_rates < max)
156*61046927SAndroid Build Coastguard Worker rates[nr_rates] = rate;
157*61046927SAndroid Build Coastguard Worker nr_rates++;
158*61046927SAndroid Build Coastguard Worker
159*61046927SAndroid Build Coastguard Worker if (max > 0 && nr_rates == max)
160*61046927SAndroid Build Coastguard Worker break;
161*61046927SAndroid Build Coastguard Worker }
162*61046927SAndroid Build Coastguard Worker
163*61046927SAndroid Build Coastguard Worker return nr_rates;
164*61046927SAndroid Build Coastguard Worker }
165*61046927SAndroid Build Coastguard Worker
166*61046927SAndroid Build Coastguard Worker unsigned
panfrost_afrc_get_modifiers(enum pipe_format format,uint32_t rate,unsigned max,uint64_t * modifiers)167*61046927SAndroid Build Coastguard Worker panfrost_afrc_get_modifiers(enum pipe_format format, uint32_t rate,
168*61046927SAndroid Build Coastguard Worker unsigned max, uint64_t *modifiers)
169*61046927SAndroid Build Coastguard Worker {
170*61046927SAndroid Build Coastguard Worker if (!panfrost_format_supports_afrc(format))
171*61046927SAndroid Build Coastguard Worker return 0;
172*61046927SAndroid Build Coastguard Worker
173*61046927SAndroid Build Coastguard Worker /* For now, the number of components in a clump is always the same no
174*61046927SAndroid Build Coastguard Worker * matter the layout for all supported formats */
175*61046927SAndroid Build Coastguard Worker unsigned clump_comps = panfrost_afrc_clump_get_nr_components(format, false);
176*61046927SAndroid Build Coastguard Worker unsigned count = 0;
177*61046927SAndroid Build Coastguard Worker
178*61046927SAndroid Build Coastguard Worker /* FIXME Choose a more sensitive default compression rate? */
179*61046927SAndroid Build Coastguard Worker if (rate == PAN_AFRC_RATE_DEFAULT) {
180*61046927SAndroid Build Coastguard Worker if (max > 0)
181*61046927SAndroid Build Coastguard Worker modifiers[0] = DRM_FORMAT_MOD_ARM_AFRC(AFRC_FORMAT_MOD_CU_SIZE_24);
182*61046927SAndroid Build Coastguard Worker
183*61046927SAndroid Build Coastguard Worker if (max > 1)
184*61046927SAndroid Build Coastguard Worker modifiers[1] = DRM_FORMAT_MOD_ARM_AFRC(AFRC_FORMAT_MOD_CU_SIZE_24 |
185*61046927SAndroid Build Coastguard Worker AFRC_FORMAT_MOD_LAYOUT_SCAN);
186*61046927SAndroid Build Coastguard Worker
187*61046927SAndroid Build Coastguard Worker return 2;
188*61046927SAndroid Build Coastguard Worker }
189*61046927SAndroid Build Coastguard Worker
190*61046927SAndroid Build Coastguard Worker for (unsigned i = 0; i < ARRAY_SIZE(panfrost_afrc_block_sizes); ++i) {
191*61046927SAndroid Build Coastguard Worker unsigned clump_sz = panfrost_afrc_block_sizes[i].size * 8;
192*61046927SAndroid Build Coastguard Worker if (rate == clump_sz / clump_comps) {
193*61046927SAndroid Build Coastguard Worker for (unsigned scan = 0; scan < 2; ++scan) {
194*61046927SAndroid Build Coastguard Worker if (count < max) {
195*61046927SAndroid Build Coastguard Worker modifiers[count] = DRM_FORMAT_MOD_ARM_AFRC(
196*61046927SAndroid Build Coastguard Worker panfrost_afrc_block_sizes[i].modifier_flag |
197*61046927SAndroid Build Coastguard Worker (scan ? AFRC_FORMAT_MOD_LAYOUT_SCAN : 0));
198*61046927SAndroid Build Coastguard Worker }
199*61046927SAndroid Build Coastguard Worker count++;
200*61046927SAndroid Build Coastguard Worker }
201*61046927SAndroid Build Coastguard Worker }
202*61046927SAndroid Build Coastguard Worker }
203*61046927SAndroid Build Coastguard Worker
204*61046927SAndroid Build Coastguard Worker return count;
205*61046927SAndroid Build Coastguard Worker }
206*61046927SAndroid Build Coastguard Worker
207*61046927SAndroid Build Coastguard Worker uint32_t
panfrost_afrc_get_rate(enum pipe_format format,uint64_t modifier)208*61046927SAndroid Build Coastguard Worker panfrost_afrc_get_rate(enum pipe_format format, uint64_t modifier)
209*61046927SAndroid Build Coastguard Worker {
210*61046927SAndroid Build Coastguard Worker if (!drm_is_afrc(modifier) || !panfrost_format_supports_afrc(format))
211*61046927SAndroid Build Coastguard Worker return PAN_AFRC_RATE_NONE;
212*61046927SAndroid Build Coastguard Worker
213*61046927SAndroid Build Coastguard Worker bool scan = panfrost_afrc_is_scan(modifier);
214*61046927SAndroid Build Coastguard Worker unsigned block_comps = panfrost_afrc_clump_get_nr_components(format, scan);
215*61046927SAndroid Build Coastguard Worker uint32_t block_sz = panfrost_afrc_block_size_from_modifier(modifier) * 8;
216*61046927SAndroid Build Coastguard Worker
217*61046927SAndroid Build Coastguard Worker return block_sz / block_comps;
218*61046927SAndroid Build Coastguard Worker }
219