linux/drivers/video/of_videomode.c
Sam Ravnborg 891948966b video: Fix kernel-doc warnings in of_display_timing + of_videomode
Fix kernel-doc warnings reported when using W=1.

v3:
  - Do not replace '-' with ':' (Thomas)

v2:
  - Improve subject (Lee)

Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: linux-fbdev@vger.kernel.org
Link: https://patchwork.freedesktop.org/patch/msgid/20201128224114.1033617-2-sam@ravnborg.org
2020-11-29 22:42:17 +01:00

52 lines
1.4 KiB
C

// SPDX-License-Identifier: GPL-2.0-only
/*
* generic videomode helper
*
* Copyright (c) 2012 Steffen Trumtrar <s.trumtrar@pengutronix.de>, Pengutronix
*/
#include <linux/errno.h>
#include <linux/export.h>
#include <linux/of.h>
#include <video/display_timing.h>
#include <video/of_display_timing.h>
#include <video/of_videomode.h>
#include <video/videomode.h>
/**
* of_get_videomode - get the videomode #<index> from devicetree
* @np: devicenode with the display_timings
* @vm: set to return value
* @index: index into list of display_timings
* (Set this to OF_USE_NATIVE_MODE to use whatever mode is
* specified as native mode in the DT.)
*
* DESCRIPTION:
* Get a list of all display timings and put the one
* specified by index into *vm. This function should only be used, if
* only one videomode is to be retrieved. A driver that needs to work
* with multiple/all videomodes should work with
* of_get_display_timings instead.
**/
int of_get_videomode(struct device_node *np, struct videomode *vm,
int index)
{
struct display_timings *disp;
int ret;
disp = of_get_display_timings(np);
if (!disp) {
pr_err("%pOF: no timings specified\n", np);
return -EINVAL;
}
if (index == OF_USE_NATIVE_MODE)
index = disp->native_mode;
ret = videomode_from_timings(disp, vm, index);
display_timings_release(disp);
return ret;
}
EXPORT_SYMBOL_GPL(of_get_videomode);