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 22435e923b90b701a77527c81ffedb50a0641390..68d05e3718612b2e0d72817d67b49ed14392113d 100644 (file)
--- 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,