src/vulkan/isl.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 /**
  25  * @file
  26  * @brief Intel Surface Layout
  27  */
  28
  29 #pragma once
  30
  31 #include <stdbool.h>
  32 #include <stdint.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct brw_device_info;
  39
  40 /**
  41  * WARNING: These values differ from the hardware enum values, which are
  42  * unstable across hardware generations.
  43  *
  44  * Note that legacy Y tiling is ISL_TILING_Y0 instead of ISL_TILING_Y, to
  45  * clearly distinguish it from Yf and Ys.
  46  */
  47 enum isl_tiling {
  48    ISL_TILING_LINEAR,
  49    ISL_TILING_W,
  50    ISL_TILING_X,
  51    ISL_TILING_Y0, /**< Legacy Y tiling */
  52    ISL_TILING_Yf,
  53    ISL_TILING_Ys,
  54 };
  55
  56 /**
  57  * Hardware enumeration SURFACE_FORMAT.
  58  *
  59  * For the official list, see Broadwell PRM: Volume 2b: Command Reference:
  60  * Enumerations: SURFACE_FORMAT.
  61  */
  62 enum isl_format {
  63    ISL_FORMAT_R32G32B32A32_FLOAT =                               0,
  64    ISL_FORMAT_R32G32B32A32_SINT =                                1,
  65    ISL_FORMAT_R32G32B32A32_UINT =                                2,
  66    ISL_FORMAT_R32G32B32A32_UNORM =                               3,
  67    ISL_FORMAT_R32G32B32A32_SNORM =                               4,
  68    ISL_FORMAT_R64G64_FLOAT =                                     5,
  69    ISL_FORMAT_R32G32B32X32_FLOAT =                               6,
  70    ISL_FORMAT_R32G32B32A32_SSCALED =                             7,
  71    ISL_FORMAT_R32G32B32A32_USCALED =                             8,
  72    ISL_FORMAT_R32G32B32A32_SFIXED =                             32,
  73    ISL_FORMAT_R64G64_PASSTHRU =                                 33,
  74    ISL_FORMAT_R32G32B32_FLOAT =                                 64,
  75    ISL_FORMAT_R32G32B32_SINT =                                  65,
  76    ISL_FORMAT_R32G32B32_UINT =                                  66,
  77    ISL_FORMAT_R32G32B32_UNORM =                                 67,
  78    ISL_FORMAT_R32G32B32_SNORM =                                 68,
  79    ISL_FORMAT_R32G32B32_SSCALED =                               69,
  80    ISL_FORMAT_R32G32B32_USCALED =                               70,
  81    ISL_FORMAT_R32G32B32_SFIXED =                                80,
  82    ISL_FORMAT_R16G16B16A16_UNORM =                             128,
  83    ISL_FORMAT_R16G16B16A16_SNORM =                             129,
  84    ISL_FORMAT_R16G16B16A16_SINT =                              130,
  85    ISL_FORMAT_R16G16B16A16_UINT =                              131,
  86    ISL_FORMAT_R16G16B16A16_FLOAT =                             132,
  87    ISL_FORMAT_R32G32_FLOAT =                                   133,
  88    ISL_FORMAT_R32G32_SINT =                                    134,
  89    ISL_FORMAT_R32G32_UINT =                                    135,
  90    ISL_FORMAT_R32_FLOAT_X8X24_TYPELESS =                       136,
  91    ISL_FORMAT_X32_TYPELESS_G8X24_UINT =                        137,
  92    ISL_FORMAT_L32A32_FLOAT =                                   138,
  93    ISL_FORMAT_R32G32_UNORM =                                   139,
  94    ISL_FORMAT_R32G32_SNORM =                                   140,
  95    ISL_FORMAT_R64_FLOAT =                                      141,
  96    ISL_FORMAT_R16G16B16X16_UNORM =                             142,
  97    ISL_FORMAT_R16G16B16X16_FLOAT =                             143,
  98    ISL_FORMAT_A32X32_FLOAT =                                   144,
  99    ISL_FORMAT_L32X32_FLOAT =                                   145,
 100    ISL_FORMAT_I32X32_FLOAT =                                   146,
 101    ISL_FORMAT_R16G16B16A16_SSCALED =                           147,
 102    ISL_FORMAT_R16G16B16A16_USCALED =                           148,
 103    ISL_FORMAT_R32G32_SSCALED =                                 149,
 104    ISL_FORMAT_R32G32_USCALED =                                 150,
 105    ISL_FORMAT_R32G32_SFIXED =                                  160,
 106    ISL_FORMAT_R64_PASSTHRU =                                   161,
 107    ISL_FORMAT_B8G8R8A8_UNORM =                                 192,
 108    ISL_FORMAT_B8G8R8A8_UNORM_SRGB =                            193,
 109    ISL_FORMAT_R10G10B10A2_UNORM =                              194,
 110    ISL_FORMAT_R10G10B10A2_UNORM_SRGB =                         195,
 111    ISL_FORMAT_R10G10B10A2_UINT =                               196,
 112    ISL_FORMAT_R10G10B10_SNORM_A2_UNORM =                       197,
 113    ISL_FORMAT_R8G8B8A8_UNORM =                                 199,
 114    ISL_FORMAT_R8G8B8A8_UNORM_SRGB =                            200,
 115    ISL_FORMAT_R8G8B8A8_SNORM =                                 201,
 116    ISL_FORMAT_R8G8B8A8_SINT =                                  202,
 117    ISL_FORMAT_R8G8B8A8_UINT =                                  203,
 118    ISL_FORMAT_R16G16_UNORM =                                   204,
 119    ISL_FORMAT_R16G16_SNORM =                                   205,
 120    ISL_FORMAT_R16G16_SINT =                                    206,
 121    ISL_FORMAT_R16G16_UINT =                                    207,
 122    ISL_FORMAT_R16G16_FLOAT =                                   208,
 123    ISL_FORMAT_B10G10R10A2_UNORM =                              209,
 124    ISL_FORMAT_B10G10R10A2_UNORM_SRGB =                         210,
 125    ISL_FORMAT_R11G11B10_FLOAT =                                211,
 126    ISL_FORMAT_R32_SINT =                                       214,
 127    ISL_FORMAT_R32_UINT =                                       215,
 128    ISL_FORMAT_R32_FLOAT =                                      216,
 129    ISL_FORMAT_R24_UNORM_X8_TYPELESS =                          217,
 130    ISL_FORMAT_X24_TYPELESS_G8_UINT =                           218,
 131    ISL_FORMAT_L32_UNORM =                                      221,
 132    ISL_FORMAT_A32_UNORM =                                      222,
 133    ISL_FORMAT_L16A16_UNORM =                                   223,
 134    ISL_FORMAT_I24X8_UNORM =                                    224,
 135    ISL_FORMAT_L24X8_UNORM =                                    225,
 136    ISL_FORMAT_A24X8_UNORM =                                    226,
 137    ISL_FORMAT_I32_FLOAT =                                      227,
 138    ISL_FORMAT_L32_FLOAT =                                      228,
 139    ISL_FORMAT_A32_FLOAT =                                      229,
 140    ISL_FORMAT_X8B8_UNORM_G8R8_SNORM =                          230,
 141    ISL_FORMAT_A8X8_UNORM_G8R8_SNORM =                          231,
 142    ISL_FORMAT_B8X8_UNORM_G8R8_SNORM =                          232,
 143    ISL_FORMAT_B8G8R8X8_UNORM =                                 233,
 144    ISL_FORMAT_B8G8R8X8_UNORM_SRGB =                            234,
 145    ISL_FORMAT_R8G8B8X8_UNORM =                                 235,
 146    ISL_FORMAT_R8G8B8X8_UNORM_SRGB =                            236,
 147    ISL_FORMAT_R9G9B9E5_SHAREDEXP =                             237,
 148    ISL_FORMAT_B10G10R10X2_UNORM =                              238,
 149    ISL_FORMAT_L16A16_FLOAT =                                   240,
 150    ISL_FORMAT_R32_UNORM =                                      241,
 151    ISL_FORMAT_R32_SNORM =                                      242,
 152    ISL_FORMAT_R10G10B10X2_USCALED =                            243,
 153    ISL_FORMAT_R8G8B8A8_SSCALED =                               244,
 154    ISL_FORMAT_R8G8B8A8_USCALED =                               245,
 155    ISL_FORMAT_R16G16_SSCALED =                                 246,
 156    ISL_FORMAT_R16G16_USCALED =                                 247,
 157    ISL_FORMAT_R32_SSCALED =                                    248,
 158    ISL_FORMAT_R32_USCALED =                                    249,
 159    ISL_FORMAT_B5G6R5_UNORM =                                   256,
 160    ISL_FORMAT_B5G6R5_UNORM_SRGB =                              257,
 161    ISL_FORMAT_B5G5R5A1_UNORM =                                 258,
 162    ISL_FORMAT_B5G5R5A1_UNORM_SRGB =                            259,
 163    ISL_FORMAT_B4G4R4A4_UNORM =                                 260,
 164    ISL_FORMAT_B4G4R4A4_UNORM_SRGB =                            261,
 165    ISL_FORMAT_R8G8_UNORM =                                     262,
 166    ISL_FORMAT_R8G8_SNORM =                                     263,
 167    ISL_FORMAT_R8G8_SINT =                                      264,
 168    ISL_FORMAT_R8G8_UINT =                                      265,
 169    ISL_FORMAT_R16_UNORM =                                      266,
 170    ISL_FORMAT_R16_SNORM =                                      267,
 171    ISL_FORMAT_R16_SINT =                                       268,
 172    ISL_FORMAT_R16_UINT =                                       269,
 173    ISL_FORMAT_R16_FLOAT =                                      270,
 174    ISL_FORMAT_A8P8_UNORM_PALETTE0 =                            271,
 175    ISL_FORMAT_A8P8_UNORM_PALETTE1 =                            272,
 176    ISL_FORMAT_I16_UNORM =                                      273,
 177    ISL_FORMAT_L16_UNORM =                                      274,
 178    ISL_FORMAT_A16_UNORM =                                      275,
 179    ISL_FORMAT_L8A8_UNORM =                                     276,
 180    ISL_FORMAT_I16_FLOAT =                                      277,
 181    ISL_FORMAT_L16_FLOAT =                                      278,
 182    ISL_FORMAT_A16_FLOAT =                                      279,
 183    ISL_FORMAT_L8A8_UNORM_SRGB =                                280,
 184    ISL_FORMAT_R5G5_SNORM_B6_UNORM =                            281,
 185    ISL_FORMAT_B5G5R5X1_UNORM =                                 282,
 186    ISL_FORMAT_B5G5R5X1_UNORM_SRGB =                            283,
 187    ISL_FORMAT_R8G8_SSCALED =                                   284,
 188    ISL_FORMAT_R8G8_USCALED =                                   285,
 189    ISL_FORMAT_R16_SSCALED =                                    286,
 190    ISL_FORMAT_R16_USCALED =                                    287,
 191    ISL_FORMAT_P8A8_UNORM_PALETTE0 =                            290,
 192    ISL_FORMAT_P8A8_UNORM_PALETTE1 =                            291,
 193    ISL_FORMAT_A1B5G5R5_UNORM =                                 292,
 194    ISL_FORMAT_A4B4G4R4_UNORM =                                 293,
 195    ISL_FORMAT_L8A8_UINT =                                      294,
 196    ISL_FORMAT_L8A8_SINT =                                      295,
 197    ISL_FORMAT_R8_UNORM =                                       320,
 198    ISL_FORMAT_R8_SNORM =                                       321,
 199    ISL_FORMAT_R8_SINT =                                        322,
 200    ISL_FORMAT_R8_UINT =                                        323,
 201    ISL_FORMAT_A8_UNORM =                                       324,
 202    ISL_FORMAT_I8_UNORM =                                       325,
 203    ISL_FORMAT_L8_UNORM =                                       326,
 204    ISL_FORMAT_P4A4_UNORM_PALETTE0 =                            327,
 205    ISL_FORMAT_A4P4_UNORM_PALETTE0 =                            328,
 206    ISL_FORMAT_R8_SSCALED =                                     329,
 207    ISL_FORMAT_R8_USCALED =                                     330,
 208    ISL_FORMAT_P8_UNORM_PALETTE0 =                              331,
 209    ISL_FORMAT_L8_UNORM_SRGB =                                  332,
 210    ISL_FORMAT_P8_UNORM_PALETTE1 =                              333,
 211    ISL_FORMAT_P4A4_UNORM_PALETTE1 =                            334,
 212    ISL_FORMAT_A4P4_UNORM_PALETTE1 =                            335,
 213    ISL_FORMAT_Y8_UNORM =                                       336,
 214    ISL_FORMAT_L8_UINT =                                        338,
 215    ISL_FORMAT_L8_SINT =                                        339,
 216    ISL_FORMAT_I8_UINT =                                        340,
 217    ISL_FORMAT_I8_SINT =                                        341,
 218    ISL_FORMAT_DXT1_RGB_SRGB =                                  384,
 219    ISL_FORMAT_R1_UNORM =                                       385,
 220    ISL_FORMAT_YCRCB_NORMAL =                                   386,
 221    ISL_FORMAT_YCRCB_SWAPUVY =                                  387,
 222    ISL_FORMAT_P2_UNORM_PALETTE0 =                              388,
 223    ISL_FORMAT_P2_UNORM_PALETTE1 =                              389,
 224    ISL_FORMAT_BC1_UNORM =                                      390,
 225    ISL_FORMAT_BC2_UNORM =                                      391,
 226    ISL_FORMAT_BC3_UNORM =                                      392,
 227    ISL_FORMAT_BC4_UNORM =                                      393,
 228    ISL_FORMAT_BC5_UNORM =                                      394,
 229    ISL_FORMAT_BC1_UNORM_SRGB =                                 395,
 230    ISL_FORMAT_BC2_UNORM_SRGB =                                 396,
 231    ISL_FORMAT_BC3_UNORM_SRGB =                                 397,
 232    ISL_FORMAT_MONO8 =                                          398,
 233    ISL_FORMAT_YCRCB_SWAPUV =                                   399,
 234    ISL_FORMAT_YCRCB_SWAPY =                                    400,
 235    ISL_FORMAT_DXT1_RGB =                                       401,
 236    ISL_FORMAT_FXT1 =                                           402,
 237    ISL_FORMAT_R8G8B8_UNORM =                                   403,
 238    ISL_FORMAT_R8G8B8_SNORM =                                   404,
 239    ISL_FORMAT_R8G8B8_SSCALED =                                 405,
 240    ISL_FORMAT_R8G8B8_USCALED =                                 406,
 241    ISL_FORMAT_R64G64B64A64_FLOAT =                             407,
 242    ISL_FORMAT_R64G64B64_FLOAT =                                408,
 243    ISL_FORMAT_BC4_SNORM =                                      409,
 244    ISL_FORMAT_BC5_SNORM =                                      410,
 245    ISL_FORMAT_R16G16B16_FLOAT =                                411,
 246    ISL_FORMAT_R16G16B16_UNORM =                                412,
 247    ISL_FORMAT_R16G16B16_SNORM =                                413,
 248    ISL_FORMAT_R16G16B16_SSCALED =                              414,
 249    ISL_FORMAT_R16G16B16_USCALED =                              415,
 250    ISL_FORMAT_BC6H_SF16 =                                      417,
 251    ISL_FORMAT_BC7_UNORM =                                      418,
 252    ISL_FORMAT_BC7_UNORM_SRGB =                                 419,
 253    ISL_FORMAT_BC6H_UF16 =                                      420,
 254    ISL_FORMAT_PLANAR_420_8 =                                   421,
 255    ISL_FORMAT_R8G8B8_UNORM_SRGB =                              424,
 256    ISL_FORMAT_ETC1_RGB8 =                                      425,
 257    ISL_FORMAT_ETC2_RGB8 =                                      426,
 258    ISL_FORMAT_EAC_R11 =                                        427,
 259    ISL_FORMAT_EAC_RG11 =                                       428,
 260    ISL_FORMAT_EAC_SIGNED_R11 =                                 429,
 261    ISL_FORMAT_EAC_SIGNED_RG11 =                                430,
 262    ISL_FORMAT_ETC2_SRGB8 =                                     431,
 263    ISL_FORMAT_R16G16B16_UINT =                                 432,
 264    ISL_FORMAT_R16G16B16_SINT =                                 433,
 265    ISL_FORMAT_R32_SFIXED =                                     434,
 266    ISL_FORMAT_R10G10B10A2_SNORM =                              435,
 267    ISL_FORMAT_R10G10B10A2_USCALED =                            436,
 268    ISL_FORMAT_R10G10B10A2_SSCALED =                            437,
 269    ISL_FORMAT_R10G10B10A2_SINT =                               438,
 270    ISL_FORMAT_B10G10R10A2_SNORM =                              439,
 271    ISL_FORMAT_B10G10R10A2_USCALED =                            440,
 272    ISL_FORMAT_B10G10R10A2_SSCALED =                            441,
 273    ISL_FORMAT_B10G10R10A2_UINT =                               442,
 274    ISL_FORMAT_B10G10R10A2_SINT =                               443,
 275    ISL_FORMAT_R64G64B64A64_PASSTHRU =                          444,
 276    ISL_FORMAT_R64G64B64_PASSTHRU =                             445,
 277    ISL_FORMAT_ETC2_RGB8_PTA =                                  448,
 278    ISL_FORMAT_ETC2_SRGB8_PTA =                                 449,
 279    ISL_FORMAT_ETC2_EAC_RGBA8 =                                 450,
 280    ISL_FORMAT_ETC2_EAC_SRGB8_A8 =                              451,
 281    ISL_FORMAT_R8G8B8_UINT =                                    456,
 282    ISL_FORMAT_R8G8B8_SINT =                                    457,
 283    ISL_FORMAT_RAW =                                            511,
 284
 285    /* Hardware doesn't understand this out-of-band value */
 286    ISL_FORMAT_UNSUPPORTED =                             UINT16_MAX,
 287 };
 288
 289 enum isl_base_type {
 290    ISL_VOID,
 291    ISL_RAW,
 292    ISL_UNORM,
 293    ISL_SNORM,
 294    ISL_UFLOAT,
 295    ISL_SFLOAT,
 296    ISL_UFIXED,
 297    ISL_SFIXED,
 298    ISL_UINT,
 299    ISL_SINT,
 300    ISL_USCALED,
 301    ISL_SSCALED,
 302 };
 303
 304 enum isl_colorspace {
 305    ISL_COLORSPACE_NONE = 0,
 306    ISL_COLORSPACE_LINEAR,
 307    ISL_COLORSPACE_SRGB,
 308    ISL_COLORSPACE_YUV,
 309 };
 310
 311 /**
 312  * Texture compression mode
 313  */
 314 enum isl_txc {
 315    ISL_TXC_NONE = 0,
 316    ISL_TXC_DXT1,
 317    ISL_TXC_DXT3,
 318    ISL_TXC_DXT5,
 319    ISL_TXC_FXT1,
 320    ISL_TXC_RGTC1,
 321    ISL_TXC_RGTC2,
 322    ISL_TXC_BPTC,
 323    ISL_TXC_ETC1,
 324    ISL_TXC_ETC2,
 325 };
 326
 327 struct isl_device {
 328    const struct brw_device_info *info;
 329 };
 330
 331 struct isl_extent2d {
 332    uint32_t width;
 333    uint32_t height;
 334 };
 335
 336 struct isl_extent3d {
 337    uint32_t width;
 338    uint32_t height;
 339    uint32_t depth;
 340 };
 341
 342 struct isl_channel_layout {
 343    enum isl_base_type type;
 344    uint8_t bits; /**< Size in bits */
 345 };
 346
 347 struct isl_format_layout {
 348    enum isl_format format;
 349
 350    uint16_t bpb; /**< Bits per block */
 351    uint8_t bs; /**< Block size, in bytes, rounded towards 0 */
 352    uint8_t bw; /**< Block width, in pixels */
 353    uint8_t bh; /**< Block height, in pixels */
 354    uint8_t bd; /**< Block depth, in pixels */
 355
 356    struct {
 357       struct isl_channel_layout r; /**< Red channel */
 358       struct isl_channel_layout g; /**< Green channel */
 359       struct isl_channel_layout b; /**< Blue channel */
 360       struct isl_channel_layout a; /**< Alpha channel */
 361       struct isl_channel_layout l; /**< Luminance channel */
 362       struct isl_channel_layout i; /**< Intensity channel */
 363       struct isl_channel_layout p; /**< Palette channel */
 364    } channels;
 365
 366    enum isl_colorspace colorspace;
 367    enum isl_txc txc;
 368 };
 369
 370 void
 371 isl_device_init(struct isl_device *dev,
 372                 const struct brw_device_info *info);
 373
 374 void
 375 isl_tiling_get_extent(const struct isl_device *dev,
 376                       enum isl_tiling tiling,
 377                       uint32_t cpp,
 378                       struct isl_extent2d *e);
 379
 380 extern const struct isl_format_layout isl_format_layouts[];
 381
 382 #ifdef __cplusplus
 383 }
 384 #endif