Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-12-29 17:25:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

drm/vram-helper: Fix 'multi-line' kernel-doc comments

Browse Source 
Reformat lines in kernel-doc comments, which make use of the backslash at
the end to suggest it is a multi-line comment. kernel-doc is able to
process e.g. the short description of a function properly, even if it is
across two lines.

No functional change.

Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Reviewed-by: Jani Nikula <jani.nikula@intel.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240122093152.22536-2-anna-maria@linutronix.de
This commit is contained in:
Anna-Maria Behnsen 2024-01-22 10:31:51 +01:00 committed by Jonathan Corbet
parent d546978e0c
commit a0abb82d25
2 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
drivers/gpu/drm/drm_gem_vram_helper.c
View File

@ -260,8 +260,7 @@ static u64 drm_gem_vram_pg_offset(struct drm_gem_vram_object *gbo)
} }
/** /**
* drm_gem_vram_offset() - \ * drm_gem_vram_offset() - Returns a GEM VRAM object's offset in video memory
Returns a GEM VRAM object's offset in video memory
* @gbo: the GEM VRAM object * @gbo: the GEM VRAM object
* *
* This function returns the buffer object's offset in the device's video * This function returns the buffer object's offset in the device's video
@ -470,14 +469,15 @@ void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo,
EXPORT_SYMBOL(drm_gem_vram_vunmap); EXPORT_SYMBOL(drm_gem_vram_vunmap);
/** /**
* drm_gem_vram_fill_create_dumb() - \ * drm_gem_vram_fill_create_dumb() - Helper for implementing
Helper for implementing &struct drm_driver.dumb_create * &struct drm_driver.dumb_create
*
* @file: the DRM file * @file: the DRM file
* @dev: the DRM device * @dev: the DRM device
* @pg_align: the buffer's alignment in multiples of the page size * @pg_align: the buffer's alignment in multiples of the page size
* @pitch_align: the scanline's alignment in powers of 2 * @pitch_align: the scanline's alignment in powers of 2
* @args: the arguments as provided to \ * @args: the arguments as provided to
&struct drm_driver.dumb_create * &struct drm_driver.dumb_create
* *
* This helper function fills &struct drm_mode_create_dumb, which is used * This helper function fills &struct drm_mode_create_dumb, which is used
* by &struct drm_driver.dumb_create. Implementations of this interface * by &struct drm_driver.dumb_create. Implementations of this interface
@ -575,8 +575,7 @@ static int drm_gem_vram_bo_driver_move(struct drm_gem_vram_object *gbo,
*/ */
/** /**
* drm_gem_vram_object_free() - \ * drm_gem_vram_object_free() - Implements &struct drm_gem_object_funcs.free
Implements &struct drm_gem_object_funcs.free
* @gem: GEM object. Refers to &struct drm_gem_vram_object.gem * @gem: GEM object. Refers to &struct drm_gem_vram_object.gem
*/ */
static void drm_gem_vram_object_free(struct drm_gem_object *gem) static void drm_gem_vram_object_free(struct drm_gem_object *gem)
@ -591,12 +590,11 @@ static void drm_gem_vram_object_free(struct drm_gem_object *gem)
*/ */
/** /**
* drm_gem_vram_driver_dumb_create() - \ * drm_gem_vram_driver_dumb_create() - Implements &struct drm_driver.dumb_create
Implements &struct drm_driver.dumb_create
* @file: the DRM file * @file: the DRM file
* @dev: the DRM device * @dev: the DRM device
* @args: the arguments as provided to \ * @args: the arguments as provided to
&struct drm_driver.dumb_create * &struct drm_driver.dumb_create
* *
* This function requires the driver to use @drm_device.vram_mm for its * This function requires the driver to use @drm_device.vram_mm for its
* instance of VRAM MM. * instance of VRAM MM.
@ -639,8 +637,8 @@ static void __drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane,
} }
/** /**
* drm_gem_vram_plane_helper_prepare_fb() - \ * drm_gem_vram_plane_helper_prepare_fb() - Implements &struct
* Implements &struct drm_plane_helper_funcs.prepare_fb * drm_plane_helper_funcs.prepare_fb
* @plane: a DRM plane * @plane: a DRM plane
* @new_state: the plane's new state * @new_state: the plane's new state
* *
@ -690,8 +688,8 @@ drm_gem_vram_plane_helper_prepare_fb(struct drm_plane *plane,
EXPORT_SYMBOL(drm_gem_vram_plane_helper_prepare_fb); EXPORT_SYMBOL(drm_gem_vram_plane_helper_prepare_fb);
/** /**
* drm_gem_vram_plane_helper_cleanup_fb() - \ * drm_gem_vram_plane_helper_cleanup_fb() - Implements &struct
* Implements &struct drm_plane_helper_funcs.cleanup_fb * drm_plane_helper_funcs.cleanup_fb
* @plane: a DRM plane * @plane: a DRM plane
* @old_state: the plane's old state * @old_state: the plane's old state
* *
@ -717,8 +715,8 @@ EXPORT_SYMBOL(drm_gem_vram_plane_helper_cleanup_fb);
*/ */
/** /**
* drm_gem_vram_simple_display_pipe_prepare_fb() - \ * drm_gem_vram_simple_display_pipe_prepare_fb() - Implements &struct
* Implements &struct drm_simple_display_pipe_funcs.prepare_fb * drm_simple_display_pipe_funcs.prepare_fb
* @pipe: a simple display pipe * @pipe: a simple display pipe
* @new_state: the plane's new state * @new_state: the plane's new state
* *
@ -739,8 +737,8 @@ int drm_gem_vram_simple_display_pipe_prepare_fb(
EXPORT_SYMBOL(drm_gem_vram_simple_display_pipe_prepare_fb); EXPORT_SYMBOL(drm_gem_vram_simple_display_pipe_prepare_fb);
/** /**
* drm_gem_vram_simple_display_pipe_cleanup_fb() - \ * drm_gem_vram_simple_display_pipe_cleanup_fb() - Implements &struct
* Implements &struct drm_simple_display_pipe_funcs.cleanup_fb * drm_simple_display_pipe_funcs.cleanup_fb
* @pipe: a simple display pipe * @pipe: a simple display pipe
* @old_state: the plane's old state * @old_state: the plane's old state
* *
@ -761,8 +759,7 @@ EXPORT_SYMBOL(drm_gem_vram_simple_display_pipe_cleanup_fb);
*/ */
/** /**
* drm_gem_vram_object_pin() - \ * drm_gem_vram_object_pin() - Implements &struct drm_gem_object_funcs.pin
Implements &struct drm_gem_object_funcs.pin
* @gem: The GEM object to pin * @gem: The GEM object to pin
* *
* Returns: * Returns:
@ -785,8 +782,7 @@ static int drm_gem_vram_object_pin(struct drm_gem_object *gem)
} }
/** /**
* drm_gem_vram_object_unpin() - \ * drm_gem_vram_object_unpin() - Implements &struct drm_gem_object_funcs.unpin
Implements &struct drm_gem_object_funcs.unpin
* @gem: The GEM object to unpin * @gem: The GEM object to unpin
*/ */
static void drm_gem_vram_object_unpin(struct drm_gem_object *gem) static void drm_gem_vram_object_unpin(struct drm_gem_object *gem)

16
include/drm/drm_gem_vram_helper.h
View File

@ -33,8 +33,8 @@ struct vm_area_struct;
* struct drm_gem_vram_object - GEM object backed by VRAM * struct drm_gem_vram_object - GEM object backed by VRAM
* @bo: TTM buffer object * @bo: TTM buffer object
* @map: Mapping information for @bo * @map: Mapping information for @bo
* @placement: TTM placement information. Supported placements are \ * @placement: TTM placement information. Supported placements are %TTM_PL_VRAM
%TTM_PL_VRAM and %TTM_PL_SYSTEM * and %TTM_PL_SYSTEM
* @placements: TTM placement information. * @placements: TTM placement information.
* *
* The type struct drm_gem_vram_object represents a GEM object that is * The type struct drm_gem_vram_object represents a GEM object that is
@ -126,8 +126,8 @@ drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane,
struct drm_plane_state *old_state); struct drm_plane_state *old_state);
/** /**
* DRM_GEM_VRAM_PLANE_HELPER_FUNCS - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - Initializes struct drm_plane_helper_funcs
* Initializes struct drm_plane_helper_funcs for VRAM handling * for VRAM handling
* *
* Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This * Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This
* macro initializes struct drm_plane_helper_funcs to use the respective helper * macro initializes struct drm_plane_helper_funcs to use the respective helper
@ -150,8 +150,8 @@ void drm_gem_vram_simple_display_pipe_cleanup_fb(
struct drm_plane_state *old_state); struct drm_plane_state *old_state);
/** /**
* define DRM_GEM_VRAM_DRIVER - default callback functions for \ * define DRM_GEM_VRAM_DRIVER - default callback functions for
&struct drm_driver * &struct drm_driver
* *
* Drivers that use VRAM MM and GEM VRAM can use this macro to initialize * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize
* &struct drm_driver with default functions. * &struct drm_driver with default functions.
@ -185,8 +185,8 @@ struct drm_vram_mm {
}; };
/** /**
* drm_vram_mm_of_bdev() - \ * drm_vram_mm_of_bdev() - Returns the container of type &struct ttm_device for
Returns the container of type &struct ttm_device for field bdev. * field bdev.
* @bdev: the TTM BO device * @bdev: the TTM BO device
* *
* Returns: * Returns: