[igt-dev] [i-g-t V7 18/81] tests/i915/kms_fbcon_fbt: Document each subtest for testplan

[Bhanuprakash Modem]

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

V2: - Update functionality
V3: - Driver requirement: s/any/i915, xe/

Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
Reviewed-by: Nidhi Gupta <nidhi1.gupta at intel.com>
---
 tests/i915/kms_fbcon_fbt.c | 42 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/tests/i915/kms_fbcon_fbt.c b/tests/i915/kms_fbcon_fbt.c
index 71c5285f1..e65cbda93 100644
--- a/tests/i915/kms_fbcon_fbt.c
+++ b/tests/i915/kms_fbcon_fbt.c
@@ -32,6 +32,48 @@
 #include <sys/stat.h>
 #include <fcntl.h>
 
+/**
+ * TEST: kms fbcon fbt
+ * Category: Display
+ * Description: Test the relationship between fbcon and the frontbuffer tracking
+ *              infrastructure.
+ *
+ * SUBTEST: fbc
+ * Description: Test the relationship between fbcon and the frontbuffer tracking
+ *              infrastructure with fbc enabled.
+ * Driver requirement: i915, xe
+ * Functionality: fbc, fbcon, fbt
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: fbc-suspend
+ * Description: Suspend test to validate  the relationship between fbcon and the
+ *              frontbuffer tracking infrastructure with fbc enabled.
+ * Driver requirement: i915, xe
+ * Functionality: fbc, fbcon, fbt, suspend
+ * Mega feature: General Display Features
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: psr
+ * Description: Test the relationship between fbcon and the frontbuffer tracking
+ *              infrastructure with psr enabled.
+ * Driver requirement: i915, xe
+ * Functionality: fbcon, fbt, psr
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ *
+ * SUBTEST: psr-suspend
+ * Description: Suspend test to validate the relationship between fbcon and the
+ *              frontbuffer tracking infrastructure with psr enabled.
+ * Driver requirement: i915, xe
+ * Functionality: fbcon, fbt, psr, suspend
+ * Mega feature: PSR
+ * Run type: FULL
+ * Test category: functionality test
+ */
 
 IGT_TEST_DESCRIPTION("Test the relationship between fbcon and the frontbuffer "
 		     "tracking infrastructure.");
-- 
2.40.0