Commit e32e2fe6 authored by Daniel Vetter's avatar Daniel Vetter Committed by Bartlomiej Zolnierkiewicz

fbdev: fix modedb docs in fb_find_mode

Fix up the indenting that confused sphinx. To make sure we
don't have to make the examples unreadable with escaping just
put them in as block quotes, that seems the simplest solution.
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
[b.zolnierkie: ported over fbdev changes]
Signed-off-by: default avatarBartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
parent 5c820b80
...@@ -628,45 +628,47 @@ static int fb_try_mode(struct fb_var_screeninfo *var, struct fb_info *info, ...@@ -628,45 +628,47 @@ static int fb_try_mode(struct fb_var_screeninfo *var, struct fb_info *info,
} }
/** /**
* fb_find_mode - finds a valid video mode * fb_find_mode - finds a valid video mode
* @var: frame buffer user defined part of display * @var: frame buffer user defined part of display
* @info: frame buffer info structure * @info: frame buffer info structure
* @mode_option: string video mode to find * @mode_option: string video mode to find
* @db: video mode database * @db: video mode database
* @dbsize: size of @db * @dbsize: size of @db
* @default_mode: default video mode to fall back to * @default_mode: default video mode to fall back to
* @default_bpp: default color depth in bits per pixel * @default_bpp: default color depth in bits per pixel
* *
* Finds a suitable video mode, starting with the specified mode * Finds a suitable video mode, starting with the specified mode
* in @mode_option with fallback to @default_mode. If * in @mode_option with fallback to @default_mode. If
* @default_mode fails, all modes in the video mode database will * @default_mode fails, all modes in the video mode database will
* be tried. * be tried.
* *
* Valid mode specifiers for @mode_option: * Valid mode specifiers for @mode_option::
* *
* <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][p][m] or * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][p][m]
* <name>[-<bpp>][@<refresh>] *
* or ::
* *
* with <xres>, <yres>, <bpp> and <refresh> decimal numbers and * <name>[-<bpp>][@<refresh>]
* <name> a string.
* *
* If 'M' is present after yres (and before refresh/bpp if present), * with <xres>, <yres>, <bpp> and <refresh> decimal numbers and
* the function will compute the timings using VESA(tm) Coordinated * <name> a string.
* Video Timings (CVT). If 'R' is present after 'M', will compute with
* reduced blanking (for flatpanels). If 'i' or 'p' are present, compute
* interlaced or progressive mode. If 'm' is present, add margins equal
* to 1.8% of xres rounded down to 8 pixels, and 1.8% of yres. The chars
* 'i', 'p' and 'm' must be after 'M' and 'R'. Example:
* *
* 1024x768MR-8@60m - Reduced blank with margins at 60Hz. * If 'M' is present after yres (and before refresh/bpp if present),
* the function will compute the timings using VESA(tm) Coordinated
* Video Timings (CVT). If 'R' is present after 'M', will compute with
* reduced blanking (for flatpanels). If 'i' or 'p' are present, compute
* interlaced or progressive mode. If 'm' is present, add margins equal
* to 1.8% of xres rounded down to 8 pixels, and 1.8% of yres. The char
* 'i', 'p' and 'm' must be after 'M' and 'R'. Example::
* *
* NOTE: The passed struct @var is _not_ cleared! This allows you * 1024x768MR-8@60m - Reduced blank with margins at 60Hz.
* to supply values for e.g. the grayscale and accel_flags fields.
* *
* Returns zero for failure, 1 if using specified @mode_option, * NOTE: The passed struct @var is _not_ cleared! This allows you
* 2 if using specified @mode_option with an ignored refresh rate, * to supply values for e.g. the grayscale and accel_flags fields.
* 3 if default mode is used, 4 if fall back to any valid mode.
* *
* Returns zero for failure, 1 if using specified @mode_option,
* 2 if using specified @mode_option with an ignored refresh rate,
* 3 if default mode is used, 4 if fall back to any valid mode.
*/ */
int fb_find_mode(struct fb_var_screeninfo *var, int fb_find_mode(struct fb_var_screeninfo *var,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment