From patchwork Wed Feb 21 07:39:08 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dhinakaran Pandiyan X-Patchwork-Id: 10231371 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 EC6CE60385 for ; Wed, 21 Feb 2018 07:39:22 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id DE1F128A45 for ; Wed, 21 Feb 2018 07:39:22 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id D281F28A57; Wed, 21 Feb 2018 07:39:22 +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.1 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_MED, T_DKIM_INVALID 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 0B05728A56 for ; Wed, 21 Feb 2018 07:39:21 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 557FB6E51A; Wed, 21 Feb 2018 07:39:21 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-pf0-x241.google.com (mail-pf0-x241.google.com [IPv6:2607:f8b0:400e:c00::241]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5EA056E51A; Wed, 21 Feb 2018 07:39:20 +0000 (UTC) Received: by mail-pf0-x241.google.com with SMTP id s24so356517pfm.4; Tue, 20 Feb 2018 23:39:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=r0T2U5ioE33wFSdFu8pEgMor+1rKdVwfrbV0wTu7WN8=; b=aRtMTXp7mOHInITHfO8cBAypGptSmpzxSyZtpRY3sKa36TZA8shW/r0KiJbTy+sNbp 0Lb2xeR9LKBrRldnDxH3SsUfDqYLYTMWPECdLgK2BzbUvwfHB+Mm9wpekZWgSByRSRx+ /Z+DxJFeyMD02Zi3NTu8/AOuVRQBPAy78IjmWUXrIuKqFU9UrfTAQnDq7xu53xRAivc0 WMRNyoPOO7xLPyTtTIkmcDJei06KNUnHg5nVi3H/ZTi6sKLaoLn75HnkaGijZB/yAyUu SPtGdxSxzYZ24+D1QQBFc9i7DJhB0E7r4LwyIvKelLEFN2ogl4rDcKQGM691PbrnkNTl yh8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=r0T2U5ioE33wFSdFu8pEgMor+1rKdVwfrbV0wTu7WN8=; b=hl1IF9uKtnrB60kvdWa3i6DRiRmsDfzuy1DOndUr2U+fVy7mS4IJdR28U/NcvYSOPP ztIaRB+KBwXe60097/o+89WQhEfLMvsq8VNxQ6CJ7ZhyMykYg5zvqtW404ugx30647dF MeRn6Fg4+vG8WcWU5Gzh+RnxrGPrQ4ZAqfpTJk6iLtLB0ZHJgktISgKiGqCIzJMAFQIp MiH6EwhSDaCOMbIfQkVZljCkAf7gJtP5N7qUHgyy5dj+hRsFsVtjqCrY+N5I56NBvg+3 3ozWWBrFod3kbBcqlwjP8EgeLwrMeERTnpm10Ld01PzcXuPoTPjhBHr2wosEgypo+K6z kXwQ== X-Gm-Message-State: APf1xPAvpEYg5E2mlwCQQ2t7iQIRMMdOcjOW5HaCn2vDqmg5bkASBapQ HVTgkqcF7ZoZTWKT1J5JjRlbPQ== X-Google-Smtp-Source: AH8x227cUgah7JSiSuyIofEJDGYv711oqgvnQap4Jq4e2RIP1wDLcyjWHaDYRnxsy+8i3rx1u6sjaQ== X-Received: by 10.98.14.70 with SMTP id w67mr2401881pfi.1.1519198759272; Tue, 20 Feb 2018 23:39:19 -0800 (PST) Received: from dk-ThinkPad-X260.fios-router.home (50-39-164-98.bvtn.or.frontiernet.net. [50.39.164.98]) by smtp.gmail.com with ESMTPSA id e4sm35652047pfn.66.2018.02.20.23.39.17 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 20 Feb 2018 23:39:18 -0800 (PST) From: Dhinakaran Pandiyan X-Google-Original-From: Dhinakaran Pandiyan To: intel-gfx@lists.freedesktop.org Date: Tue, 20 Feb 2018 23:39:08 -0800 Message-Id: <20180221073908.4500-1-dhinakaran.pandiyan@intel.com> X-Mailer: git-send-email 2.14.1 Subject: [Intel-gfx] [PATCH] drm/doc: Fix documentation for _vblank_restore(). X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Daniel Vetter , Dhinakaran Pandiyan , dri-devel@lists.freedesktop.org, Rodrigo Vivi MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Virus-Scanned: ClamAV using ClamSMTP No code changes, fixes doc build warnings and polish some doc text. Reported-by: Daniel Vetter Cc: Rodrigo Vivi Cc: Daniel Vetter Signed-off-by: Dhinakaran Pandiyan --- drivers/gpu/drm/drm_vblank.c | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/drivers/gpu/drm/drm_vblank.c b/drivers/gpu/drm/drm_vblank.c index c781cb426bf1..51041eec0047 100644 --- a/drivers/gpu/drm/drm_vblank.c +++ b/drivers/gpu/drm/drm_vblank.c @@ -1238,12 +1238,15 @@ void drm_crtc_vblank_on(struct drm_crtc *crtc) EXPORT_SYMBOL(drm_crtc_vblank_on); /** - * drm_vblank_restore - estimated vblanks using timestamps and update it. + * drm_vblank_restore - estimate missed vblanks and update vblank count. + * @dev: DRM device + * @pipe: CRTC index * * Power manamement features can cause frame counter resets between vblank - * disable and enable. Drivers can then use this function in their - * &drm_crtc_funcs.enable_vblank implementation to estimate the vblanks since - * the last &drm_crtc_funcs.disable_vblank. + * disable and enable. Drivers can use this function in their + * &drm_crtc_funcs.enable_vblank implementation to estimate missed vblanks since + * the last &drm_crtc_funcs.disable_vblank using timestamps and update the + * vblank counter. * * This function is the legacy version of drm_crtc_vblank_restore(). */ @@ -1284,11 +1287,14 @@ void drm_vblank_restore(struct drm_device *dev, unsigned int pipe) EXPORT_SYMBOL(drm_vblank_restore); /** - * drm_crtc_vblank_restore - estimate vblanks using timestamps and update it. + * drm_crtc_vblank_restore - estimate missed vblanks and update vblank count. + * @crtc: CRTC in question + * * Power manamement features can cause frame counter resets between vblank - * disable and enable. Drivers can then use this function in their - * &drm_crtc_funcs.enable_vblank implementation to estimate the vblanks since - * the last &drm_crtc_funcs.disable_vblank. + * disable and enable. Drivers can use this function in their + * &drm_crtc_funcs.enable_vblank implementation to estimate missed vblanks since + * the last &drm_crtc_funcs.disable_vblank using timestamps and update the + * vblank counter. */ void drm_crtc_vblank_restore(struct drm_crtc *crtc) {