Skip to content

Commit

Permalink
drm/tinydrm: Fix doc build warnings
Browse files Browse the repository at this point in the history
include/drm/tinydrm/tinydrm.h:34: warning: Function parameter or member 'fb_dirty' not described in 'tinydrm_device'
drivers/gpu/drm/tinydrm/mipi-dbi.c:272: warning: Function parameter or member 'crtc_state' not described in 'mipi_dbi_enable_flush'
drivers/gpu/drm/tinydrm/mipi-dbi.c:272: warning: Function parameter or member 'plane_state' not described in 'mipi_dbi_enable_flush'

Move struct member docs inline so it's not missed next time.

Cc: David Lechner <david@lechnology.com>
Signed-off-by: Noralf Trønnes <noralf@tronnes.org>
Reviewed-by: David Lechner <david@lechnology.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20180710150518.10528-1-noralf@tronnes.org
  • Loading branch information
Noralf Trønnes committed Jul 11, 2018
1 parent 03e3ec9 commit 5685ca0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
2 changes: 2 additions & 0 deletions drivers/gpu/drm/tinydrm/mipi-dbi.c
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,8 @@ static const struct drm_framebuffer_funcs mipi_dbi_fb_funcs = {
/**
* mipi_dbi_enable_flush - MIPI DBI enable helper
* @mipi: MIPI DBI structure
* @crtc_state: CRTC state
* @plane_state: Plane state
*
* This function sets &mipi_dbi->enabled, flushes the whole framebuffer and
* enables the backlight. Drivers can use this in their
Expand Down
23 changes: 19 additions & 4 deletions include/drm/tinydrm/tinydrm.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,31 @@

/**
* struct tinydrm_device - tinydrm device
* @drm: DRM device
* @pipe: Display pipe structure
* @dirty_lock: Serializes framebuffer flushing
* @fb_funcs: Framebuffer functions used when creating framebuffers
*/
struct tinydrm_device {
/**
* @drm: DRM device
*/
struct drm_device *drm;

/**
* @pipe: Display pipe structure
*/
struct drm_simple_display_pipe pipe;

/**
* @dirty_lock: Serializes framebuffer flushing
*/
struct mutex dirty_lock;

/**
* @fb_funcs: Framebuffer functions used when creating framebuffers
*/
const struct drm_framebuffer_funcs *fb_funcs;

/**
* @fb_dirty: Framebuffer dirty callback
*/
int (*fb_dirty)(struct drm_framebuffer *framebuffer,
struct drm_file *file_priv, unsigned flags,
unsigned color, struct drm_clip_rect *clips,
Expand Down

0 comments on commit 5685ca0

Please sign in to comment.