src/intel/isl/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  * Header Layout
  29  * -------------
  30  * The header is ordered as:
  31  *    - forward declarations
  32  *    - macros that may be overridden at compile-time for specific gens
  33  *    - enums and constants
  34  *    - structs and unions
  35  *    - functions
  36  */
  37
  38 #pragma once
  39
  40 #include <assert.h>
  41 #include <stdbool.h>
  42 #include <stdint.h>
  43
  44 #include "util/macros.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 struct brw_device_info;
  51 struct brw_image_param;
  52
  53 #ifndef ISL_DEV_GEN
  54 /**
  55  * @brief Get the hardware generation of isl_device.
  56  *
  57  * You can define this as a compile-time constant in the CFLAGS. For example,
  58  * `gcc -DISL_DEV_GEN(dev)=9 ...`.
  59  */
  60 #define ISL_DEV_GEN(__dev) ((__dev)->info->gen)
  61 #endif
  62
  63 #ifndef ISL_DEV_IS_HASWELL
  64 /**
  65  * @brief Get the hardware generation of isl_device.
  66  *
  67  * You can define this as a compile-time constant in the CFLAGS. For example,
  68  * `gcc -DISL_DEV_GEN(dev)=9 ...`.
  69  */
  70 #define ISL_DEV_IS_HASWELL(__dev) ((__dev)->info->is_haswell)
  71 #endif
  72
  73 #ifndef ISL_DEV_USE_SEPARATE_STENCIL
  74 /**
  75  * You can define this as a compile-time constant in the CFLAGS. For example,
  76  * `gcc -DISL_DEV_USE_SEPARATE_STENCIL(dev)=1 ...`.
  77  */
  78 #define ISL_DEV_USE_SEPARATE_STENCIL(__dev) ((__dev)->use_separate_stencil)
  79 #endif
  80
  81 /**
  82  * Hardware enumeration SURFACE_FORMAT.
  83  *
  84  * For the official list, see Broadwell PRM: Volume 2b: Command Reference:
  85  * Enumerations: SURFACE_FORMAT.
  86  */
  87 enum isl_format {
  88    ISL_FORMAT_R32G32B32A32_FLOAT =                               0,
  89    ISL_FORMAT_R32G32B32A32_SINT =                                1,
  90    ISL_FORMAT_R32G32B32A32_UINT =                                2,
  91    ISL_FORMAT_R32G32B32A32_UNORM =                               3,
  92    ISL_FORMAT_R32G32B32A32_SNORM =                               4,
  93    ISL_FORMAT_R64G64_FLOAT =                                     5,
  94    ISL_FORMAT_R32G32B32X32_FLOAT =                               6,
  95    ISL_FORMAT_R32G32B32A32_SSCALED =                             7,
  96    ISL_FORMAT_R32G32B32A32_USCALED =                             8,
  97    ISL_FORMAT_R32G32B32A32_SFIXED =                             32,
  98    ISL_FORMAT_R64G64_PASSTHRU =                                 33,
  99    ISL_FORMAT_R32G32B32_FLOAT =                                 64,
 100    ISL_FORMAT_R32G32B32_SINT =                                  65,
 101    ISL_FORMAT_R32G32B32_UINT =                                  66,
 102    ISL_FORMAT_R32G32B32_UNORM =                                 67,
 103    ISL_FORMAT_R32G32B32_SNORM =                                 68,
 104    ISL_FORMAT_R32G32B32_SSCALED =                               69,
 105    ISL_FORMAT_R32G32B32_USCALED =                               70,
 106    ISL_FORMAT_R32G32B32_SFIXED =                                80,
 107    ISL_FORMAT_R16G16B16A16_UNORM =                             128,
 108    ISL_FORMAT_R16G16B16A16_SNORM =                             129,
 109    ISL_FORMAT_R16G16B16A16_SINT =                              130,
 110    ISL_FORMAT_R16G16B16A16_UINT =                              131,
 111    ISL_FORMAT_R16G16B16A16_FLOAT =                             132,
 112    ISL_FORMAT_R32G32_FLOAT =                                   133,
 113    ISL_FORMAT_R32G32_SINT =                                    134,
 114    ISL_FORMAT_R32G32_UINT =                                    135,
 115    ISL_FORMAT_R32_FLOAT_X8X24_TYPELESS =                       136,
 116    ISL_FORMAT_X32_TYPELESS_G8X24_UINT =                        137,
 117    ISL_FORMAT_L32A32_FLOAT =                                   138,
 118    ISL_FORMAT_R32G32_UNORM =                                   139,
 119    ISL_FORMAT_R32G32_SNORM =                                   140,
 120    ISL_FORMAT_R64_FLOAT =                                      141,
 121    ISL_FORMAT_R16G16B16X16_UNORM =                             142,
 122    ISL_FORMAT_R16G16B16X16_FLOAT =                             143,
 123    ISL_FORMAT_A32X32_FLOAT =                                   144,
 124    ISL_FORMAT_L32X32_FLOAT =                                   145,
 125    ISL_FORMAT_I32X32_FLOAT =                                   146,
 126    ISL_FORMAT_R16G16B16A16_SSCALED =                           147,
 127    ISL_FORMAT_R16G16B16A16_USCALED =                           148,
 128    ISL_FORMAT_R32G32_SSCALED =                                 149,
 129    ISL_FORMAT_R32G32_USCALED =                                 150,
 130    ISL_FORMAT_R32G32_SFIXED =                                  160,
 131    ISL_FORMAT_R64_PASSTHRU =                                   161,
 132    ISL_FORMAT_B8G8R8A8_UNORM =                                 192,
 133    ISL_FORMAT_B8G8R8A8_UNORM_SRGB =                            193,
 134    ISL_FORMAT_R10G10B10A2_UNORM =                              194,
 135    ISL_FORMAT_R10G10B10A2_UNORM_SRGB =                         195,
 136    ISL_FORMAT_R10G10B10A2_UINT =                               196,
 137    ISL_FORMAT_R10G10B10_SNORM_A2_UNORM =                       197,
 138    ISL_FORMAT_R8G8B8A8_UNORM =                                 199,
 139    ISL_FORMAT_R8G8B8A8_UNORM_SRGB =                            200,
 140    ISL_FORMAT_R8G8B8A8_SNORM =                                 201,
 141    ISL_FORMAT_R8G8B8A8_SINT =                                  202,
 142    ISL_FORMAT_R8G8B8A8_UINT =                                  203,
 143    ISL_FORMAT_R16G16_UNORM =                                   204,
 144    ISL_FORMAT_R16G16_SNORM =                                   205,
 145    ISL_FORMAT_R16G16_SINT =                                    206,
 146    ISL_FORMAT_R16G16_UINT =                                    207,
 147    ISL_FORMAT_R16G16_FLOAT =                                   208,
 148    ISL_FORMAT_B10G10R10A2_UNORM =                              209,
 149    ISL_FORMAT_B10G10R10A2_UNORM_SRGB =                         210,
 150    ISL_FORMAT_R11G11B10_FLOAT =                                211,
 151    ISL_FORMAT_R32_SINT =                                       214,
 152    ISL_FORMAT_R32_UINT =                                       215,
 153    ISL_FORMAT_R32_FLOAT =                                      216,
 154    ISL_FORMAT_R24_UNORM_X8_TYPELESS =                          217,
 155    ISL_FORMAT_X24_TYPELESS_G8_UINT =                           218,
 156    ISL_FORMAT_L32_UNORM =                                      221,
 157    ISL_FORMAT_A32_UNORM =                                      222,
 158    ISL_FORMAT_L16A16_UNORM =                                   223,
 159    ISL_FORMAT_I24X8_UNORM =                                    224,
 160    ISL_FORMAT_L24X8_UNORM =                                    225,
 161    ISL_FORMAT_A24X8_UNORM =                                    226,
 162    ISL_FORMAT_I32_FLOAT =                                      227,
 163    ISL_FORMAT_L32_FLOAT =                                      228,
 164    ISL_FORMAT_A32_FLOAT =                                      229,
 165    ISL_FORMAT_X8B8_UNORM_G8R8_SNORM =                          230,
 166    ISL_FORMAT_A8X8_UNORM_G8R8_SNORM =                          231,
 167    ISL_FORMAT_B8X8_UNORM_G8R8_SNORM =                          232,
 168    ISL_FORMAT_B8G8R8X8_UNORM =                                 233,
 169    ISL_FORMAT_B8G8R8X8_UNORM_SRGB =                            234,
 170    ISL_FORMAT_R8G8B8X8_UNORM =                                 235,
 171    ISL_FORMAT_R8G8B8X8_UNORM_SRGB =                            236,
 172    ISL_FORMAT_R9G9B9E5_SHAREDEXP =                             237,
 173    ISL_FORMAT_B10G10R10X2_UNORM =                              238,
 174    ISL_FORMAT_L16A16_FLOAT =                                   240,
 175    ISL_FORMAT_R32_UNORM =                                      241,
 176    ISL_FORMAT_R32_SNORM =                                      242,
 177    ISL_FORMAT_R10G10B10X2_USCALED =                            243,
 178    ISL_FORMAT_R8G8B8A8_SSCALED =                               244,
 179    ISL_FORMAT_R8G8B8A8_USCALED =                               245,
 180    ISL_FORMAT_R16G16_SSCALED =                                 246,
 181    ISL_FORMAT_R16G16_USCALED =                                 247,
 182    ISL_FORMAT_R32_SSCALED =                                    248,
 183    ISL_FORMAT_R32_USCALED =                                    249,
 184    ISL_FORMAT_B5G6R5_UNORM =                                   256,
 185    ISL_FORMAT_B5G6R5_UNORM_SRGB =                              257,
 186    ISL_FORMAT_B5G5R5A1_UNORM =                                 258,
 187    ISL_FORMAT_B5G5R5A1_UNORM_SRGB =                            259,
 188    ISL_FORMAT_B4G4R4A4_UNORM =                                 260,
 189    ISL_FORMAT_B4G4R4A4_UNORM_SRGB =                            261,
 190    ISL_FORMAT_R8G8_UNORM =                                     262,
 191    ISL_FORMAT_R8G8_SNORM =                                     263,
 192    ISL_FORMAT_R8G8_SINT =                                      264,
 193    ISL_FORMAT_R8G8_UINT =                                      265,
 194    ISL_FORMAT_R16_UNORM =                                      266,
 195    ISL_FORMAT_R16_SNORM =                                      267,
 196    ISL_FORMAT_R16_SINT =                                       268,
 197    ISL_FORMAT_R16_UINT =                                       269,
 198    ISL_FORMAT_R16_FLOAT =                                      270,
 199    ISL_FORMAT_A8P8_UNORM_PALETTE0 =                            271,
 200    ISL_FORMAT_A8P8_UNORM_PALETTE1 =                            272,
 201    ISL_FORMAT_I16_UNORM =                                      273,
 202    ISL_FORMAT_L16_UNORM =                                      274,
 203    ISL_FORMAT_A16_UNORM =                                      275,
 204    ISL_FORMAT_L8A8_UNORM =                                     276,
 205    ISL_FORMAT_I16_FLOAT =                                      277,
 206    ISL_FORMAT_L16_FLOAT =                                      278,
 207    ISL_FORMAT_A16_FLOAT =                                      279,
 208    ISL_FORMAT_L8A8_UNORM_SRGB =                                280,
 209    ISL_FORMAT_R5G5_SNORM_B6_UNORM =                            281,
 210    ISL_FORMAT_B5G5R5X1_UNORM =                                 282,
 211    ISL_FORMAT_B5G5R5X1_UNORM_SRGB =                            283,
 212    ISL_FORMAT_R8G8_SSCALED =                                   284,
 213    ISL_FORMAT_R8G8_USCALED =                                   285,
 214    ISL_FORMAT_R16_SSCALED =                                    286,
 215    ISL_FORMAT_R16_USCALED =                                    287,
 216    ISL_FORMAT_P8A8_UNORM_PALETTE0 =                            290,
 217    ISL_FORMAT_P8A8_UNORM_PALETTE1 =                            291,
 218    ISL_FORMAT_A1B5G5R5_UNORM =                                 292,
 219    ISL_FORMAT_A4B4G4R4_UNORM =                                 293,
 220    ISL_FORMAT_L8A8_UINT =                                      294,
 221    ISL_FORMAT_L8A8_SINT =                                      295,
 222    ISL_FORMAT_R8_UNORM =                                       320,
 223    ISL_FORMAT_R8_SNORM =                                       321,
 224    ISL_FORMAT_R8_SINT =                                        322,
 225    ISL_FORMAT_R8_UINT =                                        323,
 226    ISL_FORMAT_A8_UNORM =                                       324,
 227    ISL_FORMAT_I8_UNORM =                                       325,
 228    ISL_FORMAT_L8_UNORM =                                       326,
 229    ISL_FORMAT_P4A4_UNORM_PALETTE0 =                            327,
 230    ISL_FORMAT_A4P4_UNORM_PALETTE0 =                            328,
 231    ISL_FORMAT_R8_SSCALED =                                     329,
 232    ISL_FORMAT_R8_USCALED =                                     330,
 233    ISL_FORMAT_P8_UNORM_PALETTE0 =                              331,
 234    ISL_FORMAT_L8_UNORM_SRGB =                                  332,
 235    ISL_FORMAT_P8_UNORM_PALETTE1 =                              333,
 236    ISL_FORMAT_P4A4_UNORM_PALETTE1 =                            334,
 237    ISL_FORMAT_A4P4_UNORM_PALETTE1 =                            335,
 238    ISL_FORMAT_Y8_UNORM =                                       336,
 239    ISL_FORMAT_L8_UINT =                                        338,
 240    ISL_FORMAT_L8_SINT =                                        339,
 241    ISL_FORMAT_I8_UINT =                                        340,
 242    ISL_FORMAT_I8_SINT =                                        341,
 243    ISL_FORMAT_DXT1_RGB_SRGB =                                  384,
 244    ISL_FORMAT_R1_UNORM =                                       385,
 245    ISL_FORMAT_YCRCB_NORMAL =                                   386,
 246    ISL_FORMAT_YCRCB_SWAPUVY =                                  387,
 247    ISL_FORMAT_P2_UNORM_PALETTE0 =                              388,
 248    ISL_FORMAT_P2_UNORM_PALETTE1 =                              389,
 249    ISL_FORMAT_BC1_UNORM =                                      390,
 250    ISL_FORMAT_BC2_UNORM =                                      391,
 251    ISL_FORMAT_BC3_UNORM =                                      392,
 252    ISL_FORMAT_BC4_UNORM =                                      393,
 253    ISL_FORMAT_BC5_UNORM =                                      394,
 254    ISL_FORMAT_BC1_UNORM_SRGB =                                 395,
 255    ISL_FORMAT_BC2_UNORM_SRGB =                                 396,
 256    ISL_FORMAT_BC3_UNORM_SRGB =                                 397,
 257    ISL_FORMAT_MONO8 =                                          398,
 258    ISL_FORMAT_YCRCB_SWAPUV =                                   399,
 259    ISL_FORMAT_YCRCB_SWAPY =                                    400,
 260    ISL_FORMAT_DXT1_RGB =                                       401,
 261    ISL_FORMAT_FXT1 =                                           402,
 262    ISL_FORMAT_R8G8B8_UNORM =                                   403,
 263    ISL_FORMAT_R8G8B8_SNORM =                                   404,
 264    ISL_FORMAT_R8G8B8_SSCALED =                                 405,
 265    ISL_FORMAT_R8G8B8_USCALED =                                 406,
 266    ISL_FORMAT_R64G64B64A64_FLOAT =                             407,
 267    ISL_FORMAT_R64G64B64_FLOAT =                                408,
 268    ISL_FORMAT_BC4_SNORM =                                      409,
 269    ISL_FORMAT_BC5_SNORM =                                      410,
 270    ISL_FORMAT_R16G16B16_FLOAT =                                411,
 271    ISL_FORMAT_R16G16B16_UNORM =                                412,
 272    ISL_FORMAT_R16G16B16_SNORM =                                413,
 273    ISL_FORMAT_R16G16B16_SSCALED =                              414,
 274    ISL_FORMAT_R16G16B16_USCALED =                              415,
 275    ISL_FORMAT_BC6H_SF16 =                                      417,
 276    ISL_FORMAT_BC7_UNORM =                                      418,
 277    ISL_FORMAT_BC7_UNORM_SRGB =                                 419,
 278    ISL_FORMAT_BC6H_UF16 =                                      420,
 279    ISL_FORMAT_PLANAR_420_8 =                                   421,
 280    ISL_FORMAT_R8G8B8_UNORM_SRGB =                              424,
 281    ISL_FORMAT_ETC1_RGB8 =                                      425,
 282    ISL_FORMAT_ETC2_RGB8 =                                      426,
 283    ISL_FORMAT_EAC_R11 =                                        427,
 284    ISL_FORMAT_EAC_RG11 =                                       428,
 285    ISL_FORMAT_EAC_SIGNED_R11 =                                 429,
 286    ISL_FORMAT_EAC_SIGNED_RG11 =                                430,
 287    ISL_FORMAT_ETC2_SRGB8 =                                     431,
 288    ISL_FORMAT_R16G16B16_UINT =                                 432,
 289    ISL_FORMAT_R16G16B16_SINT =                                 433,
 290    ISL_FORMAT_R32_SFIXED =                                     434,
 291    ISL_FORMAT_R10G10B10A2_SNORM =                              435,
 292    ISL_FORMAT_R10G10B10A2_USCALED =                            436,
 293    ISL_FORMAT_R10G10B10A2_SSCALED =                            437,
 294    ISL_FORMAT_R10G10B10A2_SINT =                               438,
 295    ISL_FORMAT_B10G10R10A2_SNORM =                              439,
 296    ISL_FORMAT_B10G10R10A2_USCALED =                            440,
 297    ISL_FORMAT_B10G10R10A2_SSCALED =                            441,
 298    ISL_FORMAT_B10G10R10A2_UINT =                               442,
 299    ISL_FORMAT_B10G10R10A2_SINT =                               443,
 300    ISL_FORMAT_R64G64B64A64_PASSTHRU =                          444,
 301    ISL_FORMAT_R64G64B64_PASSTHRU =                             445,
 302    ISL_FORMAT_ETC2_RGB8_PTA =                                  448,
 303    ISL_FORMAT_ETC2_SRGB8_PTA =                                 449,
 304    ISL_FORMAT_ETC2_EAC_RGBA8 =                                 450,
 305    ISL_FORMAT_ETC2_EAC_SRGB8_A8 =                              451,
 306    ISL_FORMAT_R8G8B8_UINT =                                    456,
 307    ISL_FORMAT_R8G8B8_SINT =                                    457,
 308    ISL_FORMAT_RAW =                                            511,
 309
 310    /* Hardware doesn't understand this out-of-band value */
 311    ISL_FORMAT_UNSUPPORTED =                             UINT16_MAX,
 312 };
 313
 314 /**
 315  * Numerical base type for channels of isl_format.
 316  */
 317 enum isl_base_type {
 318    ISL_VOID,
 319    ISL_RAW,
 320    ISL_UNORM,
 321    ISL_SNORM,
 322    ISL_UFLOAT,
 323    ISL_SFLOAT,
 324    ISL_UFIXED,
 325    ISL_SFIXED,
 326    ISL_UINT,
 327    ISL_SINT,
 328    ISL_USCALED,
 329    ISL_SSCALED,
 330 };
 331
 332 /**
 333  * Colorspace of isl_format.
 334  */
 335 enum isl_colorspace {
 336    ISL_COLORSPACE_NONE = 0,
 337    ISL_COLORSPACE_LINEAR,
 338    ISL_COLORSPACE_SRGB,
 339    ISL_COLORSPACE_YUV,
 340 };
 341
 342 /**
 343  * Texture compression mode of isl_format.
 344  */
 345 enum isl_txc {
 346    ISL_TXC_NONE = 0,
 347    ISL_TXC_DXT1,
 348    ISL_TXC_DXT3,
 349    ISL_TXC_DXT5,
 350    ISL_TXC_FXT1,
 351    ISL_TXC_RGTC1,
 352    ISL_TXC_RGTC2,
 353    ISL_TXC_BPTC,
 354    ISL_TXC_ETC1,
 355    ISL_TXC_ETC2,
 356 };
 357
 358 /**
 359  * @brief Hardware tile mode
 360  *
 361  * WARNING: These values differ from the hardware enum values, which are
 362  * unstable across hardware generations.
 363  *
 364  * Note that legacy Y tiling is ISL_TILING_Y0 instead of ISL_TILING_Y, to
 365  * clearly distinguish it from Yf and Ys.
 366  */
 367 enum isl_tiling {
 368    ISL_TILING_LINEAR = 0,
 369    ISL_TILING_W,
 370    ISL_TILING_X,
 371    ISL_TILING_Y0, /**< Legacy Y tiling */
 372    ISL_TILING_Yf, /**< Standard 4K tiling. The 'f' means "four". */
 373    ISL_TILING_Ys, /**< Standard 64K tiling. The 's' means "sixty-four". */
 374 };
 375
 376 /**
 377  * @defgroup Tiling Flags
 378  * @{
 379  */
 380 typedef uint32_t isl_tiling_flags_t;
 381 #define ISL_TILING_LINEAR_BIT             (1u << ISL_TILING_LINEAR)
 382 #define ISL_TILING_W_BIT                  (1u << ISL_TILING_W)
 383 #define ISL_TILING_X_BIT                  (1u << ISL_TILING_X)
 384 #define ISL_TILING_Y0_BIT                 (1u << ISL_TILING_Y0)
 385 #define ISL_TILING_Yf_BIT                 (1u << ISL_TILING_Yf)
 386 #define ISL_TILING_Ys_BIT                 (1u << ISL_TILING_Ys)
 387 #define ISL_TILING_ANY_MASK               (~0u)
 388 #define ISL_TILING_NON_LINEAR_MASK        (~ISL_TILING_LINEAR_BIT)
 389
 390 /** Any Y tiling, including legacy Y tiling. */
 391 #define ISL_TILING_ANY_Y_MASK             (ISL_TILING_Y0_BIT | \
 392                                            ISL_TILING_Yf_BIT | \
 393                                            ISL_TILING_Ys_BIT)
 394
 395 /** The Skylake BSpec refers to Yf and Ys as "standard tiling formats". */
 396 #define ISL_TILING_STD_Y_MASK             (ISL_TILING_Yf_BIT | \
 397                                            ISL_TILING_Ys_BIT)
 398 /** @} */
 399
 400 /**
 401  * @brief Logical dimension of surface.
 402  *
 403  * Note: There is no dimension for cube map surfaces. ISL interprets cube maps
 404  * as 2D array surfaces.
 405  */
 406 enum isl_surf_dim {
 407    ISL_SURF_DIM_1D,
 408    ISL_SURF_DIM_2D,
 409    ISL_SURF_DIM_3D,
 410 };
 411
 412 /**
 413  * @brief Physical layout of the surface's dimensions.
 414  */
 415 enum isl_dim_layout {
 416    /**
 417     * For details, see the G35 PRM >> Volume 1: Graphics Core >> Section
 418     * 6.17.3: 2D Surfaces.
 419     *
 420     * On many gens, 1D surfaces share the same layout as 2D surfaces.  From
 421     * the G35 PRM >> Volume 1: Graphics Core >> Section 6.17.2: 1D Surfaces:
 422     *
 423     *    One-dimensional surfaces are identical to 2D surfaces with height of
 424     *    one.
 425     *
 426     * @invariant isl_surf::phys_level0_sa::depth == 1
 427     */
 428    ISL_DIM_LAYOUT_GEN4_2D,
 429
 430    /**
 431     * For details, see the G35 PRM >> Volume 1: Graphics Core >> Section
 432     * 6.17.5: 3D Surfaces.
 433     *
 434     * @invariant isl_surf::phys_level0_sa::array_len == 1
 435     */
 436    ISL_DIM_LAYOUT_GEN4_3D,
 437
 438    /**
 439     * For details, see the Skylake BSpec >> Memory Views >> Common Surface
 440     * Formats >> Surface Layout and Tiling >> » 1D Surfaces.
 441     */
 442    ISL_DIM_LAYOUT_GEN9_1D,
 443 };
 444
 445 /* TODO(chadv): Explain */
 446 enum isl_array_pitch_span {
 447    ISL_ARRAY_PITCH_SPAN_FULL,
 448    ISL_ARRAY_PITCH_SPAN_COMPACT,
 449 };
 450
 451 /**
 452  * @defgroup Surface Usage
 453  * @{
 454  */
 455 typedef uint64_t isl_surf_usage_flags_t;
 456 #define ISL_SURF_USAGE_RENDER_TARGET_BIT       (1u << 0)
 457 #define ISL_SURF_USAGE_DEPTH_BIT               (1u << 1)
 458 #define ISL_SURF_USAGE_STENCIL_BIT             (1u << 2)
 459 #define ISL_SURF_USAGE_TEXTURE_BIT             (1u << 3)
 460 #define ISL_SURF_USAGE_CUBE_BIT                (1u << 4)
 461 #define ISL_SURF_USAGE_DISABLE_AUX_BIT         (1u << 5)
 462 #define ISL_SURF_USAGE_DISPLAY_BIT             (1u << 6)
 463 #define ISL_SURF_USAGE_DISPLAY_ROTATE_90_BIT   (1u << 7)
 464 #define ISL_SURF_USAGE_DISPLAY_ROTATE_180_BIT  (1u << 8)
 465 #define ISL_SURF_USAGE_DISPLAY_ROTATE_270_BIT  (1u << 9)
 466 #define ISL_SURF_USAGE_DISPLAY_FLIP_X_BIT      (1u << 10)
 467 #define ISL_SURF_USAGE_DISPLAY_FLIP_Y_BIT      (1u << 11)
 468 #define ISL_SURF_USAGE_STORAGE_BIT             (1u << 12)
 469 /** @} */
 470
 471 /**
 472  * @brief A channel select (also known as texture swizzle) value
 473  */
 474 enum isl_channel_select {
 475    ISL_CHANNEL_SELECT_ZERO = 0,
 476    ISL_CHANNEL_SELECT_ONE = 1,
 477    ISL_CHANNEL_SELECT_RED = 4,
 478    ISL_CHANNEL_SELECT_GREEN = 5,
 479    ISL_CHANNEL_SELECT_BLUE = 6,
 480    ISL_CHANNEL_SELECT_ALPHA = 7,
 481 };
 482
 483 /**
 484  * Identical to VkSampleCountFlagBits.
 485  */
 486 enum isl_sample_count {
 487    ISL_SAMPLE_COUNT_1_BIT     = 1u,
 488    ISL_SAMPLE_COUNT_2_BIT     = 2u,
 489    ISL_SAMPLE_COUNT_4_BIT     = 4u,
 490    ISL_SAMPLE_COUNT_8_BIT     = 8u,
 491    ISL_SAMPLE_COUNT_16_BIT    = 16u,
 492 };
 493 typedef uint32_t isl_sample_count_mask_t;
 494
 495 /**
 496  * @brief Multisample Format
 497  */
 498 enum isl_msaa_layout {
 499    /**
 500     * @brief Suface is single-sampled.
 501     */
 502    ISL_MSAA_LAYOUT_NONE,
 503
 504    /**
 505     * @brief [SNB+] Interleaved Multisample Format
 506     *
 507     * In this format, multiple samples are interleaved into each cacheline.
 508     * In other words, the sample index is swizzled into the low 6 bits of the
 509     * surface's virtual address space.
 510     *
 511     * For example, suppose the surface is legacy Y tiled, is 4x multisampled,
 512     * and its pixel format is 32bpp. Then the first cacheline is arranged
 513     * thus:
 514     *
 515     *    (0,0,0) (0,1,0)   (0,0,1) (1,0,1)
 516     *    (1,0,0) (1,1,0)   (0,1,1) (1,1,1)
 517     *
 518     *    (0,0,2) (1,0,2)   (0,0,3) (1,0,3)
 519     *    (0,1,2) (1,1,2)   (0,1,3) (1,1,3)
 520     *
 521     * The hardware docs refer to this format with multiple terms.  In
 522     * Sandybridge, this is the only multisample format; so no term is used.
 523     * The Ivybridge docs refer to surfaces in this format as IMS (Interleaved
 524     * Multisample Surface). Later hardware docs additionally refer to this
 525     * format as MSFMT_DEPTH_STENCIL (because the format is deprecated for
 526     * color surfaces).
 527     *
 528     * See the Sandybridge PRM, Volume 4, Part 1, Section 2.7 "Multisampled
 529     * Surface Behavior".
 530     *
 531     * See the Ivybridge PRM, Volume 1, Part 1, Section 6.18.4.1 "Interleaved
 532     * Multisampled Surfaces".
 533     */
 534    ISL_MSAA_LAYOUT_INTERLEAVED,
 535
 536    /**
 537     * @brief [IVB+] Array Multisample Format
 538     *
 539     * In this format, the surface's physical layout resembles that of a
 540     * 2D array surface.
 541     *
 542     * Suppose the multisample surface's logical extent is (w, h) and its
 543     * sample count is N. Then surface's physical extent is the same as
 544     * a singlesample 2D surface whose logical extent is (w, h) and array
 545     * length is N.  Array slice `i` contains the pixel values for sample
 546     * index `i`.
 547     *
 548     * The Ivybridge docs refer to surfaces in this format as UMS
 549     * (Uncompressed Multsample Layout) and CMS (Compressed Multisample
 550     * Surface). The Broadwell docs additionally refer to this format as
 551     * MSFMT_MSS (MSS=Multisample Surface Storage).
 552     *
 553     * See the Broadwell PRM, Volume 5 "Memory Views", Section "Uncompressed
 554     * Multisample Surfaces".
 555     *
 556     * See the Broadwell PRM, Volume 5 "Memory Views", Section "Compressed
 557     * Multisample Surfaces".
 558     */
 559    ISL_MSAA_LAYOUT_ARRAY,
 560 };
 561
 562
 563 struct isl_device {
 564    const struct brw_device_info *info;
 565    bool use_separate_stencil;
 566    bool has_bit6_swizzling;
 567 };
 568
 569 struct isl_extent2d {
 570    union { uint32_t w, width; };
 571    union { uint32_t h, height; };
 572 };
 573
 574 struct isl_extent3d {
 575    union { uint32_t w, width; };
 576    union { uint32_t h, height; };
 577    union { uint32_t d, depth; };
 578 };
 579
 580 struct isl_extent4d {
 581    union { uint32_t w, width; };
 582    union { uint32_t h, height; };
 583    union { uint32_t d, depth; };
 584    union { uint32_t a, array_len; };
 585 };
 586
 587 struct isl_channel_layout {
 588    enum isl_base_type type;
 589    uint8_t bits; /**< Size in bits */
 590 };
 591
 592 /**
 593  * Each format has 3D block extent (width, height, depth). The block extent of
 594  * compressed formats is that of the format's compression block. For example,
 595  * the block extent of ISL_FORMAT_ETC2_RGB8 is (w=4, h=4, d=1).  The block
 596  * extent of uncompressed pixel formats, such as ISL_FORMAT_R8G8B8A8_UNORM, is
 597  * is (w=1, h=1, d=1).
 598  */
 599 struct isl_format_layout {
 600    enum isl_format format;
 601
 602    uint8_t bs; /**< Block size, in bytes, rounded towards 0 */
 603    uint8_t bw; /**< Block width, in pixels */
 604    uint8_t bh; /**< Block height, in pixels */
 605    uint8_t bd; /**< Block depth, in pixels */
 606
 607    struct {
 608       struct isl_channel_layout r; /**< Red channel */
 609       struct isl_channel_layout g; /**< Green channel */
 610       struct isl_channel_layout b; /**< Blue channel */
 611       struct isl_channel_layout a; /**< Alpha channel */
 612       struct isl_channel_layout l; /**< Luminance channel */
 613       struct isl_channel_layout i; /**< Intensity channel */
 614       struct isl_channel_layout p; /**< Palette channel */
 615    } channels;
 616
 617    enum isl_colorspace colorspace;
 618    enum isl_txc txc;
 619 };
 620
 621 struct isl_tile_info {
 622    enum isl_tiling tiling;
 623    uint32_t width; /**< in bytes */
 624    uint32_t height; /**< in rows of memory */
 625    uint32_t size; /**< in bytes */
 626 };
 627
 628 /**
 629  * @brief Input to surface initialization
 630  *
 631  * @invariant width >= 1
 632  * @invariant height >= 1
 633  * @invariant depth >= 1
 634  * @invariant levels >= 1
 635  * @invariant samples >= 1
 636  * @invariant array_len >= 1
 637  *
 638  * @invariant if 1D then height == 1 and depth == 1 and samples == 1
 639  * @invariant if 2D then depth == 1
 640  * @invariant if 3D then array_len == 1 and samples == 1
 641  */
 642 struct isl_surf_init_info {
 643    enum isl_surf_dim dim;
 644    enum isl_format format;
 645
 646    uint32_t width;
 647    uint32_t height;
 648    uint32_t depth;
 649    uint32_t levels;
 650    uint32_t array_len;
 651    uint32_t samples;
 652
 653    /** Lower bound for isl_surf::alignment, in bytes. */
 654    uint32_t min_alignment;
 655
 656    /** Lower bound for isl_surf::pitch, in bytes. */
 657    uint32_t min_pitch;
 658
 659    isl_surf_usage_flags_t usage;
 660
 661    /** Flags that alter how ISL selects isl_surf::tiling.  */
 662    isl_tiling_flags_t tiling_flags;
 663 };
 664
 665 struct isl_surf {
 666    enum isl_surf_dim dim;
 667    enum isl_dim_layout dim_layout;
 668    enum isl_msaa_layout msaa_layout;
 669    enum isl_tiling tiling;
 670    enum isl_format format;
 671
 672    /**
 673     * Alignment of the upper-left sample of each subimage, in units of surface
 674     * elements.
 675     */
 676    struct isl_extent3d image_alignment_el;
 677
 678    /**
 679     * Logical extent of the surface's base level, in units of pixels.  This is
 680     * identical to the extent defined in isl_surf_init_info.
 681     */
 682    struct isl_extent4d logical_level0_px;
 683
 684    /**
 685     * Physical extent of the surface's base level, in units of physical
 686     * surface samples and aligned to the format's compression block.
 687     *
 688     * Consider isl_dim_layout as an operator that transforms a logical surface
 689     * layout to a physical surface layout. Then
 690     *
 691     *    logical_layout := (isl_surf::dim, isl_surf::logical_level0_px)
 692     *    isl_surf::phys_level0_sa := isl_surf::dim_layout * logical_layout
 693     */
 694    struct isl_extent4d phys_level0_sa;
 695
 696    uint32_t levels;
 697    uint32_t samples;
 698
 699    /** Total size of the surface, in bytes. */
 700    uint32_t size;
 701
 702    /** Required alignment for the surface's base address. */
 703    uint32_t alignment;
 704
 705    /**
 706     * Pitch between vertically adjacent surface elements, in bytes.
 707     */
 708    uint32_t row_pitch;
 709
 710    /**
 711     * Pitch between physical array slices, in rows of surface elements.
 712     */
 713    uint32_t array_pitch_el_rows;
 714
 715    enum isl_array_pitch_span array_pitch_span;
 716
 717    /** Copy of isl_surf_init_info::usage. */
 718    isl_surf_usage_flags_t usage;
 719 };
 720
 721 struct isl_view {
 722    /**
 723     * Indicates the usage of the particular view
 724     *
 725     * Normally, this is one bit.  However, for a cube map texture, it
 726     * should be ISL_SURF_USAGE_TEXTURE_BIT | ISL_SURF_USAGE_CUBE_BIT.
 727     */
 728    isl_surf_usage_flags_t usage;
 729
 730    /**
 731     * The format to use in the view
 732     *
 733     * This may differ from the format of the actual isl_surf but must have
 734     * the same block size.
 735     */
 736    enum isl_format format;
 737
 738    uint32_t base_level;
 739    uint32_t levels;
 740
 741    /**
 742     * Base array layer
 743     *
 744     * For cube maps, both base_array_layer and array_len should be
 745     * specified in terms of 2-D layers and must be a multiple of 6.
 746     */
 747    uint32_t base_array_layer;
 748    uint32_t array_len;
 749
 750    enum isl_channel_select channel_select[4];
 751 };
 752
 753 union isl_color_value {
 754    float f32[4];
 755    uint32_t u32[4];
 756    int32_t i32[4];
 757 };
 758
 759 struct isl_surf_fill_state_info {
 760    const struct isl_surf *surf;
 761    const struct isl_view *view;
 762
 763    /**
 764     * The address of the surface in GPU memory.
 765     */
 766    uint64_t address;
 767
 768    /**
 769     * The Memory Object Control state for the filled surface state.
 770     *
 771     * The exact format of this value depends on hardware generation.
 772     */
 773    uint32_t mocs;
 774
 775    /**
 776     * The clear color for this surface
 777     *
 778     * Valid values depend on hardware generation.
 779     */
 780    union isl_color_value clear_color;
 781 };
 782
 783 struct isl_buffer_fill_state_info {
 784    /**
 785     * The address of the surface in GPU memory.
 786     */
 787    uint64_t address;
 788
 789    /**
 790     * The size of the buffer
 791     */
 792    uint64_t size;
 793
 794    /**
 795     * The Memory Object Control state for the filled surface state.
 796     *
 797     * The exact format of this value depends on hardware generation.
 798     */
 799    uint32_t mocs;
 800
 801    /**
 802     * The format to use in the surface state
 803     *
 804     * This may differ from the format of the actual isl_surf but have the
 805     * same block size.
 806     */
 807    enum isl_format format;
 808
 809    uint32_t stride;
 810 };
 811
 812 extern const struct isl_format_layout isl_format_layouts[];
 813
 814 void
 815 isl_device_init(struct isl_device *dev,
 816                 const struct brw_device_info *info,
 817                 bool has_bit6_swizzling);
 818
 819 isl_sample_count_mask_t ATTRIBUTE_CONST
 820 isl_device_get_sample_counts(struct isl_device *dev);
 821
 822 static inline const struct isl_format_layout * ATTRIBUTE_CONST
 823 isl_format_get_layout(enum isl_format fmt)
 824 {
 825    return &isl_format_layouts[fmt];
 826 }
 827
 828 bool
 829 isl_format_has_sint_channel(enum isl_format fmt) ATTRIBUTE_CONST;
 830
 831 static inline bool
 832 isl_format_is_compressed(enum isl_format fmt)
 833 {
 834    const struct isl_format_layout *fmtl = isl_format_get_layout(fmt);
 835
 836    return fmtl->txc != ISL_TXC_NONE;
 837 }
 838
 839 static inline bool
 840 isl_format_has_bc_compression(enum isl_format fmt)
 841 {
 842    switch (isl_format_get_layout(fmt)->txc) {
 843    case ISL_TXC_DXT1:
 844    case ISL_TXC_DXT3:
 845    case ISL_TXC_DXT5:
 846       return true;
 847    case ISL_TXC_NONE:
 848    case ISL_TXC_FXT1:
 849    case ISL_TXC_RGTC1:
 850    case ISL_TXC_RGTC2:
 851    case ISL_TXC_BPTC:
 852    case ISL_TXC_ETC1:
 853    case ISL_TXC_ETC2:
 854       return false;
 855    }
 856
 857    unreachable("bad texture compression mode");
 858    return false;
 859 }
 860
 861 static inline bool
 862 isl_format_is_yuv(enum isl_format fmt)
 863 {
 864    const struct isl_format_layout *fmtl = isl_format_get_layout(fmt);
 865
 866    return fmtl->colorspace == ISL_COLORSPACE_YUV;
 867 }
 868
 869 static inline bool
 870 isl_format_block_is_1x1x1(enum isl_format fmt)
 871 {
 872    const struct isl_format_layout *fmtl = isl_format_get_layout(fmt);
 873
 874    return fmtl->bw == 1 && fmtl->bh == 1 && fmtl->bd == 1;
 875 }
 876
 877 static inline bool
 878 isl_format_is_rgb(enum isl_format fmt)
 879 {
 880    return isl_format_layouts[fmt].channels.r.bits > 0 &&
 881           isl_format_layouts[fmt].channels.g.bits > 0 &&
 882           isl_format_layouts[fmt].channels.b.bits > 0 &&
 883           isl_format_layouts[fmt].channels.a.bits == 0;
 884 }
 885
 886 enum isl_format isl_format_rgb_to_rgba(enum isl_format rgb) ATTRIBUTE_CONST;
 887 enum isl_format isl_format_rgb_to_rgbx(enum isl_format rgb) ATTRIBUTE_CONST;
 888
 889 bool isl_is_storage_image_format(enum isl_format fmt);
 890
 891 enum isl_format
 892 isl_lower_storage_image_format(const struct isl_device *dev,
 893                                enum isl_format fmt);
 894
 895 static inline bool
 896 isl_tiling_is_any_y(enum isl_tiling tiling)
 897 {
 898    return (1u << tiling) & ISL_TILING_ANY_MASK;
 899 }
 900
 901 static inline bool
 902 isl_tiling_is_std_y(enum isl_tiling tiling)
 903 {
 904    return (1u << tiling) & ISL_TILING_STD_Y_MASK;
 905 }
 906
 907 bool
 908 isl_tiling_get_info(const struct isl_device *dev,
 909                     enum isl_tiling tiling,
 910                     uint32_t format_block_size,
 911                     struct isl_tile_info *info);
 912
 913 void
 914 isl_tiling_get_extent(const struct isl_device *dev,
 915                       enum isl_tiling tiling,
 916                       uint32_t format_block_size,
 917                       struct isl_extent2d *e);
 918 bool
 919 isl_surf_choose_tiling(const struct isl_device *dev,
 920                        const struct isl_surf_init_info *restrict info,
 921                        enum isl_tiling *tiling);
 922
 923 static inline bool
 924 isl_surf_usage_is_display(isl_surf_usage_flags_t usage)
 925 {
 926    return usage & ISL_SURF_USAGE_DISPLAY_BIT;
 927 }
 928
 929 static inline bool
 930 isl_surf_usage_is_depth(isl_surf_usage_flags_t usage)
 931 {
 932    return usage & ISL_SURF_USAGE_DEPTH_BIT;
 933 }
 934
 935 static inline bool
 936 isl_surf_usage_is_stencil(isl_surf_usage_flags_t usage)
 937 {
 938    return usage & ISL_SURF_USAGE_STENCIL_BIT;
 939 }
 940
 941 static inline bool
 942 isl_surf_usage_is_depth_and_stencil(isl_surf_usage_flags_t usage)
 943 {
 944    return (usage & ISL_SURF_USAGE_DEPTH_BIT) &&
 945           (usage & ISL_SURF_USAGE_STENCIL_BIT);
 946 }
 947
 948 static inline bool
 949 isl_surf_usage_is_depth_or_stencil(isl_surf_usage_flags_t usage)
 950 {
 951    return usage & (ISL_SURF_USAGE_DEPTH_BIT | ISL_SURF_USAGE_STENCIL_BIT);
 952 }
 953
 954 static inline bool
 955 isl_surf_info_is_z16(const struct isl_surf_init_info *info)
 956 {
 957    return (info->usage & ISL_SURF_USAGE_DEPTH_BIT) &&
 958           (info->format == ISL_FORMAT_R16_UNORM);
 959 }
 960
 961 static inline bool
 962 isl_surf_info_is_z32_float(const struct isl_surf_init_info *info)
 963 {
 964    return (info->usage & ISL_SURF_USAGE_DEPTH_BIT) &&
 965           (info->format == ISL_FORMAT_R32_FLOAT);
 966 }
 967
 968 static inline struct isl_extent2d
 969 isl_extent2d(uint32_t width, uint32_t height)
 970 {
 971    return (struct isl_extent2d) { .w = width, .h = height };
 972 }
 973
 974 static inline struct isl_extent3d
 975 isl_extent3d(uint32_t width, uint32_t height, uint32_t depth)
 976 {
 977    return (struct isl_extent3d) { .w = width, .h = height, .d = depth };
 978 }
 979
 980 static inline struct isl_extent4d
 981 isl_extent4d(uint32_t width, uint32_t height, uint32_t depth,
 982              uint32_t array_len)
 983 {
 984    return (struct isl_extent4d) {
 985       .w = width,
 986       .h = height,
 987       .d = depth,
 988       .a = array_len,
 989    };
 990 }
 991
 992 #define isl_surf_init(dev, surf, ...) \
 993    isl_surf_init_s((dev), (surf), \
 994                    &(struct isl_surf_init_info) {  __VA_ARGS__ });
 995
 996 bool
 997 isl_surf_init_s(const struct isl_device *dev,
 998                 struct isl_surf *surf,
 999                 const struct isl_surf_init_info *restrict info);
1000
1001 void
1002 isl_surf_get_tile_info(const struct isl_device *dev,
1003                        const struct isl_surf *surf,
1004                        struct isl_tile_info *tile_info);
1005
1006 #define isl_surf_fill_state(dev, state, ...) \
1007    isl_surf_fill_state_s((dev), (state), \
1008                          &(struct isl_surf_fill_state_info) {  __VA_ARGS__ });
1009
1010 void
1011 isl_surf_fill_state_s(const struct isl_device *dev, void *state,
1012                       const struct isl_surf_fill_state_info *restrict info);
1013
1014 #define isl_buffer_fill_state(dev, state, ...) \
1015    isl_buffer_fill_state_s((dev), (state), \
1016                            &(struct isl_buffer_fill_state_info) {  __VA_ARGS__ });
1017
1018 void
1019 isl_buffer_fill_state_s(const struct isl_device *dev, void *state,
1020                         const struct isl_buffer_fill_state_info *restrict info);
1021
1022 void
1023 isl_surf_fill_image_param(const struct isl_device *dev,
1024                           struct brw_image_param *param,
1025                           const struct isl_surf *surf,
1026                           const struct isl_view *view);
1027
1028 void
1029 isl_buffer_fill_image_param(const struct isl_device *dev,
1030                             struct brw_image_param *param,
1031                             enum isl_format format,
1032                             uint64_t size);
1033
1034 /**
1035  * Alignment of the upper-left sample of each subimage, in units of surface
1036  * elements.
1037  */
1038 static inline struct isl_extent3d
1039 isl_surf_get_image_alignment_el(const struct isl_surf *surf)
1040 {
1041    return surf->image_alignment_el;
1042 }
1043
1044 /**
1045  * Alignment of the upper-left sample of each subimage, in units of surface
1046  * samples.
1047  */
1048 static inline struct isl_extent3d
1049 isl_surf_get_image_alignment_sa(const struct isl_surf *surf)
1050 {
1051    const struct isl_format_layout *fmtl = isl_format_get_layout(surf->format);
1052
1053    return (struct isl_extent3d) {
1054       .w = fmtl->bw * surf->image_alignment_el.w,
1055       .h = fmtl->bh * surf->image_alignment_el.h,
1056       .d = fmtl->bd * surf->image_alignment_el.d,
1057    };
1058 }
1059
1060 /**
1061  * Pitch between vertically adjacent surface elements, in bytes.
1062  */
1063 static inline uint32_t
1064 isl_surf_get_row_pitch(const struct isl_surf *surf)
1065 {
1066    return surf->row_pitch;
1067 }
1068
1069 /**
1070  * Pitch between vertically adjacent surface elements, in units of surface elements.
1071  */
1072 static inline uint32_t
1073 isl_surf_get_row_pitch_el(const struct isl_surf *surf)
1074 {
1075    const struct isl_format_layout *fmtl = isl_format_get_layout(surf->format);
1076
1077    assert(surf->row_pitch % fmtl->bs == 0);
1078    return surf->row_pitch / fmtl->bs;
1079 }
1080
1081 /**
1082  * Pitch between physical array slices, in rows of surface elements.
1083  */
1084 static inline uint32_t
1085 isl_surf_get_array_pitch_el_rows(const struct isl_surf *surf)
1086 {
1087    return surf->array_pitch_el_rows;
1088 }
1089
1090 /**
1091  * Pitch between physical array slices, in units of surface elements.
1092  */
1093 static inline uint32_t
1094 isl_surf_get_array_pitch_el(const struct isl_surf *surf)
1095 {
1096    return isl_surf_get_array_pitch_el_rows(surf) *
1097           isl_surf_get_row_pitch_el(surf);
1098 }
1099
1100 /**
1101  * Pitch between physical array slices, in rows of surface samples.
1102  */
1103 static inline uint32_t
1104 isl_surf_get_array_pitch_sa_rows(const struct isl_surf *surf)
1105 {
1106    const struct isl_format_layout *fmtl = isl_format_get_layout(surf->format);
1107    return fmtl->bh * isl_surf_get_array_pitch_el_rows(surf);
1108 }
1109
1110 /**
1111  * Pitch between physical array slices, in bytes.
1112  */
1113 static inline uint32_t
1114 isl_surf_get_array_pitch(const struct isl_surf *surf)
1115 {
1116    return isl_surf_get_array_pitch_sa_rows(surf) * surf->row_pitch;
1117 }
1118
1119 /**
1120  * Calculate the offset, in units of surface elements, to a subimage in the
1121  * surface.
1122  *
1123  * @invariant level < surface levels
1124  * @invariant logical_array_layer < logical array length of surface
1125  * @invariant logical_z_offset_px < logical depth of surface at level
1126  */
1127 void
1128 isl_surf_get_image_offset_el(const struct isl_surf *surf,
1129                              uint32_t level,
1130                              uint32_t logical_array_layer,
1131                              uint32_t logical_z_offset_px,
1132                              uint32_t *x_offset_el,
1133                              uint32_t *y_offset_el);
1134
1135 /**
1136  * @brief Calculate the intratile offsets to a subimage in the surface.
1137  *
1138  * In @a base_address_offset return the offset from the base of the surface to
1139  * the base address of the first tile of the subimage. In @a x_offset_el and
1140  * @a y_offset_el, return the offset, in units of surface elements, from the
1141  * tile's base to the subimage's first surface element. The x and y offsets
1142  * are intratile offsets; that is, they do not exceed the boundary of the
1143  * surface's tiling format.
1144  */
1145 void
1146 isl_surf_get_image_intratile_offset_el(const struct isl_device *dev,
1147                                        const struct isl_surf *surf,
1148                                        uint32_t level,
1149                                        uint32_t logical_array_layer,
1150                                        uint32_t logical_z_offset,
1151                                        uint32_t *base_address_offset,
1152                                        uint32_t *x_offset_el,
1153                                        uint32_t *y_offset_el);
1154
1155 /**
1156  * See above.
1157  */
1158 void
1159 isl_surf_get_image_intratile_offset_el_xy(const struct isl_device *dev,
1160                                        const struct isl_surf *surf,
1161                                        uint32_t total_x_offset_el,
1162                                        uint32_t total_y_offset_el,
1163                                        uint32_t *base_address_offset,
1164                                        uint32_t *x_offset_el,
1165                                        uint32_t *y_offset_el);
1166
1167 /**
1168  * @brief Get value of 3DSTATE_DEPTH_BUFFER.SurfaceFormat
1169  *
1170  * @pre surf->usage has ISL_SURF_USAGE_DEPTH_BIT
1171  * @pre surf->format must be a valid format for depth surfaces
1172  */
1173 uint32_t
1174 isl_surf_get_depth_format(const struct isl_device *dev,
1175                           const struct isl_surf *surf);
1176
1177 #ifdef __cplusplus
1178 }
1179 #endif