1# 2# Copyright 2017 Advanced Micro Devices, Inc. 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# on the rights to use, copy, modify, merge, publish, distribute, sub 8# license, and/or sell copies of the Software, and to permit persons to whom 9# the 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 NON-INFRINGEMENT. IN NO EVENT SHALL 18# THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, 19# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 20# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 21# USE OR OTHER DEALINGS IN THE SOFTWARE. 22# 23""" 24Script that generates the mapping from Gallium PIPE_FORMAT_xxx to gfx10 25IMG_FORMAT_xxx enums. 26""" 27 28from __future__ import absolute_import, division, print_function, unicode_literals 29 30import json 31import mako.template 32import os 33import re 34import sys 35 36AMD_REGISTERS = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), "../registers")) 37UTIL_FORMAT = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), "../../util/format")) 38sys.path.extend([AMD_REGISTERS, UTIL_FORMAT]) 39 40from regdb import Object, RegisterDatabase 41from u_format_parse import * 42 43# ---------------------------------------------------------------------------- 44# Hard-coded mappings 45 46def hardcoded_format(hw_enum): 47 return Object(img_format=hw_enum, flags=[]) 48 49HARDCODED = { 50 'PIPE_FORMAT_Z32_FLOAT_S8X24_UINT': hardcoded_format('X24_8_32_FLOAT'), 51 'PIPE_FORMAT_Z24_UNORM_S8_UINT': hardcoded_format('8_24_UNORM'), 52 'PIPE_FORMAT_S8_UINT_Z24_UNORM': hardcoded_format('24_8_UNORM'), 53 'PIPE_FORMAT_Z32_UNORM': None, 54 'PIPE_FORMAT_Z16_UNORM_S8_UINT': None, 55 56 'PIPE_FORMAT_R9G9B9E5_FLOAT': hardcoded_format('5_9_9_9_FLOAT'), 57 'PIPE_FORMAT_R11G11B10_FLOAT': hardcoded_format('10_11_11_FLOAT'), # NOTE: full set of int/unorm/etc. exists 58 59 'PIPE_FORMAT_R8G8_B8G8_UNORM': hardcoded_format('GB_GR_UNORM'), 60 'PIPE_FORMAT_G8R8_B8R8_UNORM': hardcoded_format('GB_GR_UNORM'), 61 62 'PIPE_FORMAT_R8G8_R8B8_UNORM': hardcoded_format('BG_RG_UNORM'), 63 'PIPE_FORMAT_G8R8_G8B8_UNORM': hardcoded_format('BG_RG_UNORM'), 64 65 # These mixed channel types are not supported natively 66 'PIPE_FORMAT_R8SG8SB8UX8U_NORM': None, 67 'PIPE_FORMAT_R10SG10SB10SA2U_NORM': None, 68 'PIPE_FORMAT_R5SG5SB6U_NORM': None, 69 70 # Only R8G8_SRGB is supported, not L8A8_SRGB 71 'PIPE_FORMAT_L8A8_SRGB': None, 72 73 # S3TC 74 'PIPE_FORMAT_DXT1_RGB': hardcoded_format('BC1_UNORM'), 75 'PIPE_FORMAT_DXT1_RGBA': hardcoded_format('BC1_UNORM'), 76 'PIPE_FORMAT_DXT1_SRGB': hardcoded_format('BC1_SRGB'), 77 'PIPE_FORMAT_DXT1_SRGBA': hardcoded_format('BC1_SRGB'), 78 'PIPE_FORMAT_DXT3_RGBA': hardcoded_format('BC2_UNORM'), 79 'PIPE_FORMAT_DXT3_SRGBA': hardcoded_format('BC2_SRGB'), 80 'PIPE_FORMAT_DXT5_RGBA': hardcoded_format('BC3_UNORM'), 81 'PIPE_FORMAT_DXT5_SRGBA': hardcoded_format('BC3_SRGB'), 82 83 # RGTC 84 'PIPE_FORMAT_RGTC1_UNORM': hardcoded_format('BC4_UNORM'), 85 'PIPE_FORMAT_RGTC1_SNORM': hardcoded_format('BC4_SNORM'), 86 'PIPE_FORMAT_RGTC2_UNORM': hardcoded_format('BC5_UNORM'), 87 'PIPE_FORMAT_RGTC2_SNORM': hardcoded_format('BC5_SNORM'), 88 'PIPE_FORMAT_LATC1_UNORM': hardcoded_format('BC4_UNORM'), 89 'PIPE_FORMAT_LATC1_SNORM': hardcoded_format('BC4_SNORM'), 90 'PIPE_FORMAT_LATC2_UNORM': hardcoded_format('BC5_UNORM'), 91 'PIPE_FORMAT_LATC2_SNORM': hardcoded_format('BC5_SNORM'), 92 93 # BPTC 94 'PIPE_FORMAT_BPTC_RGB_UFLOAT': hardcoded_format('BC6_UFLOAT'), 95 'PIPE_FORMAT_BPTC_RGB_FLOAT': hardcoded_format('BC6_SFLOAT'), 96 97 'PIPE_FORMAT_BPTC_RGBA_UNORM': hardcoded_format('BC7_UNORM'), 98 'PIPE_FORMAT_BPTC_SRGBA': hardcoded_format('BC7_SRGB'), 99 100 'PIPE_FORMAT_R64_UINT': hardcoded_format('32_32_UINT'), 101 'PIPE_FORMAT_R64_SINT': hardcoded_format('32_32_SINT'), 102} 103 104 105# ---------------------------------------------------------------------------- 106# Main script 107 108header_template = mako.template.Template("""\ 109// DO NOT EDIT -- AUTOMATICALLY GENERATED 110 111#include "gfx10_format_table.h" 112#include "amdgfxregs.h" 113 114#define FMT(_img_format, ...) \ 115 { .img_format = V_008F0C_IMG_FORMAT_##_img_format, \ 116 ##__VA_ARGS__ } 117 118const struct gfx10_format gfx10_format_table[PIPE_FORMAT_COUNT] = { 119% for pipe_format, args in formats: 120 % if args is not None: 121 [${pipe_format}] = FMT(${args}), 122 % else: 123/* ${pipe_format} is not supported */ 124 % endif 125% endfor 126}; 127""") 128 129class Gfx10Format(object): 130 RE_plain_channel = re.compile(r'X?([0-9]+)') 131 132 def __init__(self, enum_entry): 133 self.img_format = enum_entry.name[11:] 134 self.flags = getattr(enum_entry, 'flags', []) 135 136 code = self.img_format.split('_') 137 138 self.plain_chan_sizes = [] 139 for i, chan_code in enumerate(code): 140 m = self.RE_plain_channel.match(chan_code) 141 if m is None: 142 break 143 self.plain_chan_sizes.append(int(m.group(1))) 144 # Keep the bit sizes in little-endian order 145 self.plain_chan_sizes.reverse() 146 147 self.code = code[i:] 148 149 150class Gfx10FormatMapping(object): 151 def __init__(self, pipe_formats, gfx10_formats): 152 self.pipe_formats = pipe_formats 153 self.gfx10_formats = gfx10_formats 154 155 self.plain_gfx10_formats = dict( 156 (tuple(['_'.join(fmt.code)] + fmt.plain_chan_sizes), fmt) 157 for fmt in gfx10_formats if fmt.plain_chan_sizes 158 ) 159 160 def map(self, fmt): 161 if fmt.layout == PLAIN: 162 chan_type = set([chan.type for chan in fmt.le_channels if chan.type != VOID]) 163 chan_norm = set([chan.norm for chan in fmt.le_channels if chan.type != VOID]) 164 chan_pure = set([chan.pure for chan in fmt.le_channels if chan.type != VOID]) 165 if len(chan_type) > 1 or len(chan_norm) > 1 or len(chan_pure) > 1: 166 print(('Format {fmt.name} has inconsistent channel types: ' + 167 '{chan_type} {chan_norm} {chan_pure}') 168 .format(**locals()), 169 file=sys.stderr) 170 return None 171 172 chan_type = chan_type.pop() 173 chan_norm = chan_norm.pop() 174 chan_pure = chan_pure.pop() 175 chan_sizes = [chan.size for chan in fmt.le_channels if chan.size != 0] 176 177 extra_flags = [] 178 179 if fmt.colorspace == SRGB: 180 assert chan_type == UNSIGNED and chan_norm 181 num_format = 'SRGB' 182 else: 183 if chan_type == UNSIGNED: 184 if chan_pure: 185 num_format = 'UINT' 186 elif chan_sizes[0] == 32: 187 # Shader-based work-around for 32-bit non-pure-integer 188 num_format = 'UINT' 189 extra_flags.append('buffers_only') 190 elif chan_norm: 191 num_format = 'UNORM' 192 else: 193 num_format = 'USCALED' 194 elif chan_type == SIGNED: 195 if chan_pure: 196 num_format = 'SINT' 197 elif chan_sizes[0] == 32: 198 # Shader-based work-around for 32-bit non-pure-integer 199 num_format = 'SINT' 200 extra_flags.append('buffers_only') 201 elif chan_norm: 202 num_format = 'SNORM' 203 else: 204 num_format = 'SSCALED' 205 elif chan_type == FLOAT: 206 num_format = 'FLOAT' 207 208 if chan_sizes[0] == 64: 209 # Shader-based work-around for doubles 210 if len(chan_sizes) % 2 == 1: 211 # 1 or 3 loads for 1 or 3 double channels 212 chan_sizes = [32, 32] 213 else: 214 # 1 or 2 loads for 2 or 4 double channels 215 chan_sizes = [32, 32, 32, 32] 216 extra_flags.append('buffers_only') 217 else: 218 # Shader-based work-around 219 assert chan_type == FIXED 220 assert chan_sizes[0] == 32 221 num_format = 'SINT' 222 extra_flags.append('buffers_only') 223 224 # These are not supported as render targets, so we don't support 225 # them as images either. 226 if (len(chan_sizes) == 3 and chan_sizes[0] in (8, 16, 32) and 227 chan_sizes[0] == chan_sizes[1]): 228 extra_flags.append('buffers_only') 229 if chan_sizes[0] in (8, 16): 230 # Shader-based work-around: one load per channel 231 chan_sizes = [chan_sizes[0]] 232 233 # Don't expose SRGB buffer formats 234 if 'buffers_only' in extra_flags and fmt.colorspace == SRGB: 235 return None 236 237 # Don't support 4_4 because it's not supported as render targets 238 # and it's useless in other cases. 239 if len(chan_sizes) == 2 and chan_sizes[0] == 4: 240 return None 241 242 key = tuple([num_format] + chan_sizes) 243 if key not in self.plain_gfx10_formats: 244 return None 245 246 gfx10_fmt = self.plain_gfx10_formats[key] 247 return Object( 248 img_format=gfx10_fmt.img_format, 249 flags=gfx10_fmt.flags + extra_flags, 250 ) 251 252 return None 253 254 255if __name__ == '__main__': 256 pipe_formats = parse(sys.argv[1]) 257 258 with open(sys.argv[2], 'r') as filp: 259 db = RegisterDatabase.from_json(json.load(filp)) 260 261 gfx10_formats = [Gfx10Format(entry) for entry in db.enum('IMG_FORMAT').entries] 262 263 mapping = Gfx10FormatMapping(pipe_formats, gfx10_formats) 264 265 formats = [] 266 for fmt in pipe_formats: 267 if fmt.name in HARDCODED: 268 obj = HARDCODED[fmt.name] 269 else: 270 obj = mapping.map(fmt) 271 272 if obj is not None: 273 args = obj.img_format 274 if 'buffers_only' in obj.flags: 275 args += ', .buffers_only = 1' 276 else: 277 args = None 278 formats.append((fmt.name, args)) 279 280 print(header_template.render(formats=formats)) 281