From patchwork Wed Oct 31 10:01:36 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 1677901 Return-Path: X-Original-To: patchwork-dri-devel@patchwork.kernel.org Delivered-To: patchwork-process-083081@patchwork2.kernel.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by patchwork2.kernel.org (Postfix) with ESMTP id A9A17DF2F6 for ; Wed, 31 Oct 2012 10:11:38 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 807AEA0AF2 for ; Wed, 31 Oct 2012 03:11:38 -0700 (PDT) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-ee0-f49.google.com (mail-ee0-f49.google.com [74.125.83.49]) by gabe.freedesktop.org (Postfix) with ESMTP id 2791EA0AF9 for ; Wed, 31 Oct 2012 03:10:12 -0700 (PDT) Received: by mail-ee0-f49.google.com with SMTP id c1so643498eek.36 for ; Wed, 31 Oct 2012 03:10:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=YQaS+hzL8uo7oUa6Q3+AbeFnujM39qP75YrvrVPM6W8=; b=fqHts72Eq/04c+X92A3uHdcl/qpQlmt9hmltKYv4Kx0qaStAQxEmf+1pGLzIHKYHPN Z3ngdUS29LaktCXQauTEOcus56DzEJD13wslFJz75kFkc9vQWYb0quSNYaWdx0tKZRLW reJpspjYcjLJe864wVEAx24Hiwi5Q2k3gAB1Y= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references :x-gm-message-state; bh=YQaS+hzL8uo7oUa6Q3+AbeFnujM39qP75YrvrVPM6W8=; b=eTyfrOcp18uT8h2pTi2kYyAQAKg/IkYVWA58hrOaRC6BP9GM4NmV0CQ2GquZg7Kza2 JYC/LAdm+bdL/BiZIhlBNfhlVJBjwp2ytjpMUU6jBW1HJsjsk5qonpyC11VCqPp5s3KM 7vxvuqPjI7RrzOVVbImUAey/+ey5hTm9/gDWCpSFVxabRuytMd/cNUeS+Bx6xgs8QsyW qF3vQF2K6PGXs0qUrCaxY3osnLG7o288xV9bqusUbx6le/kZ84dePxjeLNpx237Kyhsz tYTnNfo/SN3nwfzgqNH0dSCLfWdSUVI0tw76UF9g1IqpuTXH5gL1v/30m1vfzvuAHzSq NppA== Received: by 10.14.0.68 with SMTP id 44mr84475265eea.1.1351678211535; Wed, 31 Oct 2012 03:10:11 -0700 (PDT) Received: from wespe.ffwll.local (178-83-130-250.dynamic.hispeed.ch. [178.83.130.250]) by mx.google.com with ESMTPS id f2sm7045485eep.2.2012.10.31.03.10.10 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 31 Oct 2012 03:10:11 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH 2/3] drm/doc: integrate fb helper reference into docs Date: Wed, 31 Oct 2012 11:01:36 +0100 Message-Id: <1351677697-13953-2-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 1.7.11.7 In-Reply-To: <1351677697-13953-1-git-send-email-daniel.vetter@ffwll.ch> References: <1351674710-11629-1-git-send-email-daniel.vetter@ffwll.ch> <1351677697-13953-1-git-send-email-daniel.vetter@ffwll.ch> X-Gm-Message-State: ALoCoQmX6Seki1s3l7TCxYDL79xwTtqC9I3VIJIQpUoV/XMS/AHks1PW+EdD6QnOHkFQhVi61pua Cc: Daniel Vetter , Laurent Pinchart X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: dri-devel-bounces+patchwork-dri-devel=patchwork.kernel.org@lists.freedesktop.org Errors-To: dri-devel-bounces+patchwork-dri-devel=patchwork.kernel.org@lists.freedesktop.org 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. Signed-off-by: Daniel Vetter --- Documentation/DocBook/drm.tmpl | 5 +++++ drivers/gpu/drm/drm_fb_helper.c | 19 ++++++++++++++----- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 43e706e..15729eb 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -2110,6 +2110,11 @@ void intel_crt_init(struct drm_device *dev) Modeset Helper Functions Reference !Edrivers/gpu/drm/drm_crtc_helper.c + + fbdev Helper Functions Reference +!Pdrivers/gpu/drm/drm_fb_helper.c fbdev helpers +!Edrivers/gpu/drm/drm_fb_helper.c + diff --git a/drivers/gpu/drm/drm_fb_helper.c b/drivers/gpu/drm/drm_fb_helper.c index 4d58d7e..320dcbc 100644 --- a/drivers/gpu/drm/drm_fb_helper.c +++ b/drivers/gpu/drm/drm_fb_helper.c @@ -41,7 +41,14 @@ MODULE_AUTHOR("David Airlie, Jesse Barnes"); MODULE_DESCRIPTION("DRM KMS helper"); 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) @@ -1291,12 +1298,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. * @@ -1330,7 +1339,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: