Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/doc: integrate fb helper reference into docs

Again only minimal changes to make kerneldoc no longer shout. Plus a
little introduction in the form of a inline DOC: section to quickly
explain what this is all about.

v2: Fixup spelling fail.

Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Dave Airlie <airlied@redhat.com>

authored by

Daniel Vetter and committed by
Dave Airlie
d0ddc033 0d4ed4c8

+20 -4
+5
Documentation/DocBook/drm.tmpl
··· 2100 2100 <title>Modeset Helper Functions Reference</title> 2101 2101 !Edrivers/gpu/drm/drm_crtc_helper.c 2102 2102 </sect2> 2103 + <sect2> 2104 + <title>fbdev Helper Functions Reference</title> 2105 + !Pdrivers/gpu/drm/drm_fb_helper.c fbdev helpers 2106 + !Edrivers/gpu/drm/drm_fb_helper.c 2107 + </sect2> 2103 2108 </sect1> 2104 2109 2105 2110 <!-- Internals: vertical blanking -->
+15 -4
drivers/gpu/drm/drm_fb_helper.c
··· 45 45 46 46 static LIST_HEAD(kernel_fb_helper_list); 47 47 48 + /** 49 + * DOC: fbdev helpers 50 + * 51 + * The fb helper functions are useful to provide an fbdev on top of a drm kernel 52 + * mode setting driver. They can be used mostly independantely from the crtc 53 + * helper functions used by many drivers to implement the kernel mode setting 54 + * interfaces. 55 + */ 56 + 48 57 /* simple single crtc case helper function */ 49 58 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper) 50 59 { ··· 1311 1302 1312 1303 /** 1313 1304 * drm_helper_initial_config - setup a sane initial connector configuration 1314 - * @dev: DRM device 1305 + * @fb_helper: fb_helper device struct 1306 + * @bpp_sel: bpp value to use for the framebuffer configuration 1315 1307 * 1316 1308 * LOCKING: 1317 - * Called at init time, must take mode config lock. 1309 + * Called at init time by the driver to set up the @fb_helper initial 1310 + * configuration, must take the mode config lock. 1318 1311 * 1319 - * Scan the CRTCs and connectors and try to put together an initial setup. 1312 + * Scans the CRTCs and connectors and tries to put together an initial setup. 1320 1313 * At the moment, this is a cloned configuration across all heads with 1321 1314 * a new framebuffer object as the backing store. 1322 1315 * ··· 1352 1341 1353 1342 /** 1354 1343 * drm_fb_helper_hotplug_event - respond to a hotplug notification by 1355 - * probing all the outputs attached to the fb. 1344 + * probing all the outputs attached to the fb 1356 1345 * @fb_helper: the drm_fb_helper 1357 1346 * 1358 1347 * LOCKING: