drm: Fix warning when building docs for scdc_helper

[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / drm_scdc_helper.c

diff --git a/drivers/gpu/drm/drm_scdc_helper.c b/drivers/gpu/drm/drm_scdc_helper.c
index 3cd96a95736d716fbb50f3343ab3d18e0fb47a15..7d1b0f011d33e1d796890bb71c88458b0ae6d054 100644 (file)
--- a/drivers/gpu/drm/drm_scdc_helper.c
+++ b/drivers/gpu/drm/drm_scdc_helper.c
@@ -194,19 +194,26 @@ EXPORT_SYMBOL(drm_scdc_set_scrambling);
  * @adapter: I2C adapter for DDC channel
  * @set: ret or reset the high clock ratio
  *
- * TMDS clock ratio calculations go like this:
- * TMDS character = 10 bit TMDS encoded value
- * TMDS character rate = The rate at which TMDS characters are transmitted(Mcsc)
- * TMDS bit rate = 10x TMDS character rate
- * As per the spec:
- * TMDS clock rate for pixel clock < 340 MHz = 1x the character rate
- *     = 1/10 pixel clock rate
- * TMDS clock rate for pixel clock > 340 MHz = 0.25x the character rate
- *     = 1/40 pixel clock rate
- *
- * Writes to the TMDS config register over SCDC channel, and:
- * sets TMDS clock ratio to 1/40 when set = 1
- * sets TMDS clock ratio to 1/10 when set = 0
+ *
+ *     TMDS clock ratio calculations go like this:
+ *             TMDS character = 10 bit TMDS encoded value
+ *
+ *             TMDS character rate = The rate at which TMDS characters are
+ *             transmitted (Mcsc)
+ *
+ *             TMDS bit rate = 10x TMDS character rate
+ *
+ *     As per the spec:
+ *             TMDS clock rate for pixel clock < 340 MHz = 1x the character
+ *             rate = 1/10 pixel clock rate
+ *
+ *             TMDS clock rate for pixel clock > 340 MHz = 0.25x the character
+ *             rate = 1/40 pixel clock rate
+ *
+ *     Writes to the TMDS config register over SCDC channel, and:
+ *             sets TMDS clock ratio to 1/40 when set = 1
+ *
+ *             sets TMDS clock ratio to 1/10 when set = 0
  *
  * Returns:
  * True if write is successful, false otherwise.