Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d0ddc033 authored by Daniel Vetter's avatar Daniel Vetter Committed by Dave Airlie
Browse files

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: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: default avatarDave Airlie <airlied@redhat.com>
parent 0d4ed4c8

Documentation/DocBook/drm.tmpl

+5 −0
Original line number Diff line number Diff line
@@ -2100,6 +2100,11 @@ void intel_crt_init(struct drm_device *dev) 
      <title>Modeset Helper Functions Reference</title>

!Edrivers/gpu/drm/drm_crtc_helper.c

    </sect2>

    <sect2>

      <title>fbdev Helper Functions Reference</title>

!Pdrivers/gpu/drm/drm_fb_helper.c fbdev helpers

!Edrivers/gpu/drm/drm_fb_helper.c

    </sect2>

  </sect1>



  <!-- Internals: vertical blanking -->

drivers/gpu/drm/drm_fb_helper.c

+15 −4
Original line number Diff line number Diff line
@@ -45,6 +45,15 @@ MODULE_LICENSE("GPL and additional rights"); 


static LIST_HEAD(kernel_fb_helper_list);



/**

 * DOC: fbdev helpers

 *

 * The fb helper functions are useful to provide an fbdev on top of a drm kernel

 * mode setting driver. They can be used mostly independantely from the crtc

 * helper functions used by many drivers to implement the kernel mode setting

 * interfaces.

 */



/* simple single crtc case helper function */

int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)

{
@@ -1302,12 +1311,14 @@ static void drm_setup_crtcs(struct drm_fb_helper *fb_helper) 


/**

 * drm_helper_initial_config - setup a sane initial connector configuration

 * @dev: DRM device

 * @fb_helper: fb_helper device struct

 * @bpp_sel: bpp value to use for the framebuffer configuration

 *

 * LOCKING:

 * Called at init time, must take mode config lock.

 * Called at init time by the driver to set up the @fb_helper initial

 * configuration, must take the mode config lock.

 *

 * Scan the CRTCs and connectors and try to put together an initial setup.

 * Scans the CRTCs and connectors and tries to put together an initial setup.

 * At the moment, this is a cloned configuration across all heads with

 * a new framebuffer object as the backing store.

 *
@@ -1341,7 +1352,7 @@ EXPORT_SYMBOL(drm_fb_helper_initial_config); 


/**

 * drm_fb_helper_hotplug_event - respond to a hotplug notification by

 *                               probing all the outputs attached to the fb.

 *                               probing all the outputs attached to the fb

 * @fb_helper: the drm_fb_helper

 *

 * LOCKING: