From patchwork Sat Aug 19 14:34:44 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Noralf_Tr=C3=B8nnes?= X-Patchwork-Id: 9910525 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id CD62960386 for ; Sat, 19 Aug 2017 14:35:59 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BF56028D59 for ; Sat, 19 Aug 2017 14:35:59 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B42CF28D6F; Sat, 19 Aug 2017 14:35:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 9D16428D59 for ; Sat, 19 Aug 2017 14:35:57 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 6B7426E117; Sat, 19 Aug 2017 14:35:36 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from smtp.domeneshop.no (smtp.domeneshop.no [IPv6:2a01:5b40:0:3005::1]) by gabe.freedesktop.org (Postfix) with ESMTPS id 4D21E6E113 for ; Sat, 19 Aug 2017 14:35:34 +0000 (UTC) Received: from 211.81-166-168.customer.lyse.net ([81.166.168.211]:48854 helo=localhost.localdomain) by smtp.domeneshop.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_CBC_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1dj4qZ-0002Pi-Qo; Sat, 19 Aug 2017 16:35:31 +0200 From: =?UTF-8?q?Noralf=20Tr=C3=B8nnes?= To: dri-devel@lists.freedesktop.org Subject: [PATCH 1/2] drm/gem-fb-helper: Cleanup docs Date: Sat, 19 Aug 2017 16:34:44 +0200 Message-Id: <1503153285-15859-1-git-send-email-noralf@tronnes.org> X-Mailer: git-send-email 2.7.4 MIME-Version: 1.0 Cc: Laurent Pinchart X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Make the docs read a little better. Cc: Laurent Pinchart Signed-off-by: Noralf Trønnes Reviewed-by: Daniel Vetter --- drivers/gpu/drm/drm_gem_framebuffer_helper.c | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/drivers/gpu/drm/drm_gem_framebuffer_helper.c b/drivers/gpu/drm/drm_gem_framebuffer_helper.c index d54a083..9a36d44 100644 --- a/drivers/gpu/drm/drm_gem_framebuffer_helper.c +++ b/drivers/gpu/drm/drm_gem_framebuffer_helper.c @@ -27,18 +27,20 @@ * DOC: overview * * This library provides helpers for drivers that don't subclass - * &drm_framebuffer and and use &drm_gem_object for their backing storage. + * &drm_framebuffer and use &drm_gem_object for their backing storage. * * Drivers without additional needs to validate framebuffers can simply use - * drm_gem_fb_create() and everything is wired up automatically. But all - * parts can be used individually. + * drm_gem_fb_create() and everything is wired up automatically. Other drivers + * can use all parts independently. */ /** * drm_gem_fb_get_obj() - Get GEM object for framebuffer - * @fb: The framebuffer + * @fb: framebuffer * @plane: Which plane * + * No reference is taken on the GEM object. + * * Returns the GEM object for given framebuffer. */ struct drm_gem_object *drm_gem_fb_get_obj(struct drm_framebuffer *fb, @@ -82,7 +84,7 @@ drm_gem_fb_alloc(struct drm_device *dev, /** * drm_gem_fb_destroy - Free GEM backed framebuffer - * @fb: DRM framebuffer + * @fb: framebuffer * * Frees a GEM backed framebuffer with its backing buffer(s) and the structure * itself. Drivers can use this as their &drm_framebuffer_funcs->destroy @@ -102,7 +104,7 @@ EXPORT_SYMBOL(drm_gem_fb_destroy); /** * drm_gem_fb_create_handle - Create handle for GEM backed framebuffer - * @fb: DRM framebuffer + * @fb: framebuffer * @file: drm file * @handle: handle created * @@ -123,9 +125,9 @@ EXPORT_SYMBOL(drm_gem_fb_create_handle); * drm_gem_fb_create_with_funcs() - helper function for the * &drm_mode_config_funcs.fb_create * callback - * @dev: DRM device + * @dev: drm device * @file: drm file for the ioctl call - * @mode_cmd: metadata from the userspace fb creation request + * @mode_cmd: data from the userspace fb creation request * @funcs: vtable to be used for the new framebuffer object * * This can be used to set &drm_framebuffer_funcs for drivers that need the @@ -193,9 +195,9 @@ static const struct drm_framebuffer_funcs drm_gem_fb_funcs = { /** * drm_gem_fb_create() - &drm_mode_config_funcs.fb_create callback function - * @dev: DRM device + * @dev: drm device * @file: drm file for the ioctl call - * @mode_cmd: metadata from the userspace fb creation request + * @mode_cmd: data from the userspace fb creation request * * If your hardware has special alignment or pitch requirements these should be * checked before calling this function. The function does buffer size @@ -214,11 +216,11 @@ EXPORT_SYMBOL_GPL(drm_gem_fb_create); /** * drm_gem_fb_prepare_fb() - Prepare gem framebuffer * @plane: Which plane - * @state: Plane state attach fence to + * @state: Plane state the fence will be attached to * * This can be used as the &drm_plane_helper_funcs.prepare_fb hook. * - * This function checks if the plane FB has an dma-buf attached, extracts + * This function checks if the plane FB has a dma-buf attached, extracts * the exclusive fence and attaches it to plane state for the atomic helper * to wait on. * @@ -247,7 +249,7 @@ EXPORT_SYMBOL_GPL(drm_gem_fb_prepare_fb); /** * drm_gem_fbdev_fb_create - Create a drm_framebuffer for fbdev emulation - * @dev: DRM device + * @dev: drm device * @sizes: fbdev size description * @pitch_align: optional pitch alignment * @obj: GEM object backing the framebuffer