[igt-dev] [i-g-t V6 27/81] tests/i915/kms_psr2_sf: Document each subtest for testplan

[Bhanuprakash Modem]

Add documentation for all kms tests which is used by IGT testplan
documentation.

V2: - Add selective-fetch to the Functionality

Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
Reviewed-by: Kunal Joshi <kunal1.joshi at intel.com>
---
 tests/i915/kms_psr2_sf.c | 85 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)

diff --git a/tests/i915/kms_psr2_sf.c b/tests/i915/kms_psr2_sf.c
index b4734e5f1..025a99332 100644
--- a/tests/i915/kms_psr2_sf.c
+++ b/tests/i915/kms_psr2_sf.c
@@ -30,6 +30,91 @@
 #include <stdbool.h>
 #include <stdio.h>
 #include <string.h>
+/**
+ * TEST: kms psr2 sf
+ * Category: Display
+ * Description: Tests to varify PSR2 selective fetch by sending multiple damaged
+ *              areas
+ *
+ * SUBTEST: %s-plane-move-continuous-%s
+ * Description: Test that selective fetch works on moving %arg[1] plane %arg[2]
+ *              visible area (no update)
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * arg[1]:
+ *
+ * @cursor:               Cursor
+ * @overlay:              Overlay
+ *
+ * arg[2]:
+ *
+ * @exceed-fully-sf:      exceeding fully
+ * @exceed-sf:            exceeding paritally
+ * @sf:                   default
+ */
+
+/**
+ * SUBTEST: cursor-plane-update-sf
+ * Description: Test that selective fetch works on cursor plane
+ * Driver requirement: any
+ * Functionality: cursor, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: overlay-plane-update-continuous-sf
+ * Description: Test that selective fetch works on overlay plane
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: overlay-plane-update-sf-dmg-area
+ * Description: Test that selective fetch works on overlay plane
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: overlay-primary-update-sf-dmg-area
+ * Description: Test that selective fetch works on primary plane with blended
+ *              overlay plane
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: plane-move-sf-dmg-area
+ * Description: Test that selective fetch works on moving overlay plane
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: primary-plane-update-sf-dmg-area
+ * Description: Test that selective fetch works on primary plane
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: primary-plane-update-sf-dmg-area-big-fb
+ * Description: Test that selective fetch works on primary plane with big fb
+ * Driver requirement: any
+ * Functionality: plane, psr2, selective_fetch
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ */
 
 IGT_TEST_DESCRIPTION("Tests to varify PSR2 selective fetch by sending multiple"
 		     " damaged areas");
-- 
2.40.0