From: Chad Versace <chad.versace@intel.com>
Date: Thu, 31 Dec 2015 20:02:04 +0000 (-0800)
Subject: isl: Document some isl_surf::phys_level0_sa invariants
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=86ecb28ec6edd662775aa48513c013cadf4ddd6b;p=mesa.git

isl: Document some isl_surf::phys_level0_sa invariants

isl_dim_layout restricts the range of isl_surf::phys_level0_sa.
---

diff --git a/src/isl/isl.h b/src/isl/isl.h
index 22435e923b9..68d05e37186 100644
--- a/src/isl/isl.h
+++ b/src/isl/isl.h
@@ -492,12 +492,16 @@ enum isl_dim_layout {
     *
     *    One-dimensional surfaces are identical to 2D surfaces with height of
     *    one.
+    *
+    * @invariant isl_surf::phys_level0_sa::depth == 1
     */
    ISL_DIM_LAYOUT_GEN4_2D,
 
    /**
     * For details, see the G35 PRM >> Volume 1: Graphics Core >> Section
     * 6.17.5: 3D Surfaces.
+    *
+    * @invariant isl_surf::phys_level0_sa::array_len == 1
     */
    ISL_DIM_LAYOUT_GEN4_3D,