drm/dsi: Clarify comment on DSI hs_rate

Message ID 20181129091341.16590-1-linus.walleij@linaro.org
State New
Headers show
Series
  • drm/dsi: Clarify comment on DSI hs_rate
Related show

Commit Message

Linus Walleij Nov. 29, 2018, 9:13 a.m.
Point out that this rate is for command mode or as upper cap
on the HS rate.

Cc: Andrzej Hajda <a.hajda@samsung.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 include/drm/drm_mipi_dsi.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Patch

diff --git a/include/drm/drm_mipi_dsi.h b/include/drm/drm_mipi_dsi.h
index 491528f48cfb..d64e29333e1f 100644
--- a/include/drm/drm_mipi_dsi.h
+++ b/include/drm/drm_mipi_dsi.h
@@ -170,7 +170,9 @@  struct mipi_dsi_device_info {
  * @mode_flags: DSI operation mode related flags
  * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
  * be set to the real limits of the hardware, zero is only accepted for
- * legacy drivers
+ * legacy drivers. This is useful mainly for pure command mode panels or
+ * as an upper cap on the HS rate, as in video mode the clock rate will usually
+ * be determined from the resolution.
  * @lp_rate: maximum lane frequency for low power mode in hertz, this should
  * be set to the real limits of the hardware, zero is only accepted for
  * legacy drivers