[PATCH i-g-t] lib/igt_kms, tests: Update joiner comments for clarity

[PATCH i-g-t] lib/igt_kms, tests: Update joiner comments for clarity

[Jeevan B]

Clean up joiner-related comments to match what the code actually
checks. Remove hardcoded 5K/10K wording and update comments to refer
to bigjoiner/ultrajoiner helper checks.

Signed-off-by: Jeevan B <jeevan.b@intel.com>
---
 lib/igt_kms.c            | 17 +++++++++--------
 tests/intel/kms_joiner.c |  8 ++++----
 tests/kms_flip.c         |  4 ++--
 tests/kms_setmode.c      |  5 ++---
 4 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/lib/igt_kms.c b/lib/igt_kms.c
index e82d32130..8f45397f4 100644
--- a/lib/igt_kms.c
+++ b/lib/igt_kms.c
@@ -7047,10 +7047,11 @@ int intel_get_max_pipe_hdisplay(int drm_fd)
  * @mode: libdrm mode
  * @max_dotclock: Max pixel clock frequency
  *
- * Bigjoiner will come into the picture, when the requested
- * mode resolution > 5K or mode clock > max_dotclock.
+ * Bigjoiner is required when the requested mode exceeds single-pipe
+ * platform limits, i.e. hdisplay is above the platform threshold or
+ * clock is above @max_dotclock.
  *
- * Returns: True if mode requires Bigjoiner, else False.
+ * Returns: True if mode requires bigjoiner, else False.
  */
 bool igt_bigjoiner_possible(int drm_fd, drmModeModeInfo *mode, int max_dotclock)
 {
@@ -7065,10 +7066,10 @@ bool igt_bigjoiner_possible(int drm_fd, drmModeModeInfo *mode, int max_dotclock)
  * @max_dot_clock: max dot clock frequency
  * @mode: libdrm mode to be filled
  *
- * Bigjoiner will come in to the picture when the
- * resolution > 5K or clock > max-dot-clock.
+ * Finds the first connector mode that requires bigjoiner support based on
+ * igt_bigjoiner_possible(), while excluding modes that require ultrajoiner.
  *
- * Returns: True if big joiner found in connector modes
+ * Returns: True if a bigjoiner mode is found.
  */
 bool bigjoiner_mode_found(int drm_fd, drmModeConnector *connector,
 			  int max_dotclock, drmModeModeInfo *mode)
@@ -7385,14 +7386,14 @@ bool igt_check_bigjoiner_support(igt_display_t *display)
 	max_dotclock = igt_get_max_dotclock(display->drm_fd);
 
 	/*
-	 * if force joiner (or) mode resolution > 5K (or) mode.clock > max dot-clock,
+	 * if force joiner is enabled (or) the mode requires bigjoiner support,
 	 * then ignore
 	 *  - if the consecutive pipe is not available
 	 *  - last crtc in single/multi-connector config
 	 *  - consecutive crtcs in multi-connector config
 	 *
 	 * in multi-connector config ignore if
-	 *  - previous crtc (force joiner or mode resolution > 5K or mode.clock > max dot-clock) and
+	 *  - previous crtc (force joiner or mode requires bigjoiner support) and
 	 *  - current & previous crtcs are consecutive
 	 */
 	for (i = 0; i < pipes_in_use; i++) {
diff --git a/tests/intel/kms_joiner.c b/tests/intel/kms_joiner.c
index e6039cf9f..d26eb3b01 100644
--- a/tests/intel/kms_joiner.c
+++ b/tests/intel/kms_joiner.c
@@ -651,10 +651,10 @@ int igt_main()
 			drmModeConnector *connector = output->config.connector;
 
 			/*
-			 * Bigjoiner will come in to the picture when the
-			 * resolution > 5K or clock > max-dot-clock.
-			 * Ultrajoiner will come in to the picture when the
-			 * resolution > 10K or clock > 2 * max-dot-clock.
+			 * Bigjoiner is required when a mode exceeds the single-pipe
+			 * platform limits checked by igt_bigjoiner_possible().
+			 * Ultrajoiner is required when a mode exceeds the limits checked
+			 * by igt_ultrajoiner_possible().
 			 */
 			bigjoiner_found = bigjoiner_mode_found(data.drm_fd, connector, max_dotclock, &mode);
 			ultrajoiner_found = ultrajoiner_mode_found(data.drm_fd, connector, max_dotclock, &mode);
diff --git a/tests/kms_flip.c b/tests/kms_flip.c
index 1ef9492ba..d6514637e 100755
--- a/tests/kms_flip.c
+++ b/tests/kms_flip.c
@@ -1787,12 +1787,12 @@ static void run_test_on_crtc_set(struct test_output *o, int *crtc_idxs,
 	/*
 	 * Handle BW limitations on intel hardware:
 	 *
-	 * if force joiner (or) mode resolution > 5K (or) mode clock > max_dotclock, then ignore
+	 * if force joiner is enabled (or) the mode requires bigjoiner support, then ignore
 	 *  - last crtc in single/multi-connector config
 	 *  - consecutive crtcs in multi-connector config
 	 *
 	 * in multi-connector config ignore if
-	 *  - previous crtc (force joiner or mode resolution > 5K or mode clock > max_dotclock) and
+	 *  - previous crtc (force joiner or mode requires bigjoiner support) and
 	 *  - current & previous crtcs are consecutive
 	 */
 	if (!is_intel_device(drm_fd))
diff --git a/tests/kms_setmode.c b/tests/kms_setmode.c
index 3adc4534c..1db9a6830 100644
--- a/tests/kms_setmode.c
+++ b/tests/kms_setmode.c
@@ -795,14 +795,13 @@ static void test_one_combination(const struct test_config *tconf,
 			/*
 			 * Handle BW limitations on intel hardware:
 			 *
-			 * if force joiner (or) mode resolution > 5K (or) mode clock > max_dotclock,
+			 * if force joiner is enabled (or) the mode requires bigjoiner support,
 			 * then ignore
 			 *   - last crtc in single/multi-connector config
 			 *   - consecutive crtcs in multi-connector config
 			 *
 			 * in multi-connector config ignore if
-			 *   - previous crtc (force joiner (or) mode resolution > 5K (or)
-			 *     mode clock > max_dotclock) and
+			 *   - previous crtc (force joiner (or) mode requires bigjoiner support) and
 			 *   - current & previous crtcs are consecutive
 			 */
 			if (((igt_check_force_joiner_status(drm_fd, conn_name) ||
-- 
2.43.0