drm/panel: simple: document panel_desc; rename a few functions
authorDouglas Anderson <dianders@chromium.org>
Fri, 12 Jul 2019 16:33:33 +0000 (09:33 -0700)
committerSam Ravnborg <sam@ravnborg.org>
Wed, 17 Jul 2019 17:27:33 +0000 (19:27 +0200)
commite362cc6a247551ead1b3121521ac7a11d397db81
tree5b614385a3cd9ee7cade4f438d34e9f6f6454d23
parent57a1b0893782090738a879293efeb93885e0519c
drm/panel: simple: document panel_desc; rename a few functions

This attempts to address outstanding review feedback from
commit b8a2948fa2b3 ("drm/panel: simple: Add ability to override typical timing")

Specifically:

* It was requested that I document (in the structure definition) that
  the device tree override had no effect if 'struct drm_display_mode'
  was used in the panel description.  I have provided full Doxygen
  comments for 'struct panel_desc' to accomplish that.
* panel_simple_get_fixed_modes() was thought to be a confusing name,
  so it has been renamed to panel_simple_get_display_modes().
* panel_simple_parse_override_mode() was thought to be better named as
  panel_simple_parse_panel_timing_node().

Suggested-by: Sam Ravnborg <sam@ravnborg.org>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20190712163333.231884-1-dianders@chromium.org
drivers/gpu/drm/panel/panel-simple.c