[PATCH V2] drm: update kerneldoc for changes introduced by commits "16fadc2568e9" and "9671e228fb78"

[PATCH V2] drm: update kerneldoc for changes introduced by commits "16fadc2568e9" and "9671e228fb78"

[Lothar Waßmann]

Describe the new parameter 'bus_flags' to of_get_drm_display_mode() in
the kerneldoc comments and add kerneldoc comments to the new function
drm_bus_flags_from_videomode().

Signed-off-by: Lothar Waßmann <LW@KARO-electronics.de>
---
Changes vs. v1:
  - added missing characters

 drivers/gpu/drm/drm_modes.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index 1570487..53f07ac 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -657,6 +657,15 @@ void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
 }
 EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
 
+/**
+ * drm_bus_flags_from_videomode - extract information about pixelclk and
+ * DE polarity from videomode and store it in a separate variable
+ * @vm: videomode structure to use
+ * @bus_flags: information about pixelclk and DE polarity will be stored here
+ *
+ * Sets DRM_BUS_FLAG_DE_(LOW|HIGH) and DRM_BUS_FLAG_PIXDATA_(POS|NEG)EDGE
+ * in @bus_flags according to DISPLAY_FLAGS found in @vm
+ */
 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
 {
 	*bus_flags = 0;
@@ -677,6 +686,7 @@ EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
  * of_get_drm_display_mode - get a drm_display_mode from devicetree
  * @np: device_node with the timing specification
  * @dmode: will be set to the return value
+ * @bus_flags: information about pixelclk and DE polarity
  * @index: index into the list of display timings in devicetree
  *
  * This function is expensive and should only be used, if only one mode is to be
-- 
2.1.4

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH V2] drm: update kerneldoc for changes introduced by commits "16fadc2568e9" and "9671e228fb78"

[Daniel Vetter]

On Tue, Aug 16, 2016 at 03:34:37PM +0200, Lothar Waßmann wrote:
> Describe the new parameter 'bus_flags' to of_get_drm_display_mode() in
> the kerneldoc comments and add kerneldoc comments to the new function
> drm_bus_flags_from_videomode().
> 
> Signed-off-by: Lothar Waßmann <LW@KARO-electronics.de>

Applied to drm-misc, thanks.
-Daniel

> ---
> Changes vs. v1:
>   - added missing characters
> 
>  drivers/gpu/drm/drm_modes.c | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
> index 1570487..53f07ac 100644
> --- a/drivers/gpu/drm/drm_modes.c
> +++ b/drivers/gpu/drm/drm_modes.c
> @@ -657,6 +657,15 @@ void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
>  }
>  EXPORT_SYMBOL_GPL(drm_display_mode_to_videomode);
>  
> +/**
> + * drm_bus_flags_from_videomode - extract information about pixelclk and
> + * DE polarity from videomode and store it in a separate variable
> + * @vm: videomode structure to use
> + * @bus_flags: information about pixelclk and DE polarity will be stored here
> + *
> + * Sets DRM_BUS_FLAG_DE_(LOW|HIGH) and DRM_BUS_FLAG_PIXDATA_(POS|NEG)EDGE
> + * in @bus_flags according to DISPLAY_FLAGS found in @vm
> + */
>  void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags)
>  {
>  	*bus_flags = 0;
> @@ -677,6 +686,7 @@ EXPORT_SYMBOL_GPL(drm_bus_flags_from_videomode);
>   * of_get_drm_display_mode - get a drm_display_mode from devicetree
>   * @np: device_node with the timing specification
>   * @dmode: will be set to the return value
> + * @bus_flags: information about pixelclk and DE polarity
>   * @index: index into the list of display timings in devicetree
>   *
>   * This function is expensive and should only be used, if only one mode is to be
> -- 
> 2.1.4
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel