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

[Bhanuprakash Modem]

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

V2: - Driver requirement: s/any/i915, xe/

Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
Reviewed-by: Karthik B S <karthik.b.s at intel.com>
---
 tests/i915/kms_big_joiner.c | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/tests/i915/kms_big_joiner.c b/tests/i915/kms_big_joiner.c
index 2ff23398a..ae38e02c5 100644
--- a/tests/i915/kms_big_joiner.c
+++ b/tests/i915/kms_big_joiner.c
@@ -24,6 +24,11 @@
  *  Karthik B S <karthik.b.s at intel.com>
  */
 
+/**
+ * TEST: kms big joiner
+ * Category: Display
+ * Description: Test big joiner
+ */
 #include "igt.h"
 
 #define MAX_HDISPLAY_PER_PIPE 5120
@@ -40,6 +45,16 @@ typedef struct {
 	uint32_t big_joiner_output[2];
 } data_t;
 
+/**
+ * SUBTEST: invalid-modeset
+ * Description: Verify if the modeset on the adjoining pipe is rejected when
+ *              the pipe is active with a big joiner modeset
+ * Driver requirement: i915, xe
+ * Functionality: 2p1p
+ * Mega feature: Bigjoiner
+ * Run type: FULL
+ * Test category: functionality test
+ */
 static void test_invalid_modeset(data_t *data)
 {
 	igt_output_t *output;
@@ -80,6 +95,15 @@ static void test_invalid_modeset(data_t *data)
 	igt_assert_lt(ret, 0);
 }
 
+/**
+ * SUBTEST: basic
+ * Description: Verify the basic modeset on big joiner mode on all pipes
+ * Driver requirement: i915, xe
+ * Functionality: 2p1p
+ * Mega feature: Bigjoiner
+ * Run type: FULL
+ * Test category: functionality test
+ */
 static void test_basic_modeset(data_t *data)
 {
 	drmModeModeInfo *mode;
@@ -118,6 +142,15 @@ static void test_basic_modeset(data_t *data)
 	igt_display_commit2(display, COMMIT_ATOMIC);
 }
 
+/**
+ * SUBTEST: 2x-modeset
+ * Description: Verify simultaneous modeset on 2 big joiner outputs
+ * Driver requirement: i915, xe
+ * Functionality: 2p1p
+ * Mega feature: Bigjoiner
+ * Run type: FULL
+ * Test category: functionality test
+ */
 static void test_dual_display(data_t *data)
 {
 	drmModeModeInfo *mode;
-- 
2.40.0