From patchwork Fri Sep 20 09:47:27 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anna Karas X-Patchwork-Id: 11154153 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 09C691747 for ; Fri, 20 Sep 2019 09:48:06 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id E5A5420665 for ; Fri, 20 Sep 2019 09:48:05 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E5A5420665 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=intel.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=intel-gfx-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 7B5546FC5E; Fri, 20 Sep 2019 09:48:05 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by gabe.freedesktop.org (Postfix) with ESMTPS id 414D16FC5E for ; Fri, 20 Sep 2019 09:48:04 +0000 (UTC) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 20 Sep 2019 02:48:03 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,528,1559545200"; d="scan'208";a="217601321" Received: from akaras-dev.fi.intel.com ([10.237.72.63]) by fmsmga002.fm.intel.com with ESMTP; 20 Sep 2019 02:48:03 -0700 From: Anna Karas To: intel-gfx@lists.freedesktop.org Date: Fri, 20 Sep 2019 12:47:27 +0300 Message-Id: <20190920094727.18289-1-anna.karas@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190919104928.22084-1-anna.karas@intel.com> References: <20190919104928.22084-1-anna.karas@intel.com> Subject: [Intel-gfx] [PATCH] drm/i915/perf: Fix use of kernel-doc format in structure members. 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: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" Insert structure members names into their descriptions to follow kernel-doc format. Reviewed-by: Chris Wilson Signed-off-by: Anna Karas Acked-by: Lionel Landwerlin --- drivers/gpu/drm/i915/i915_drv.h | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/drivers/gpu/drm/i915/i915_drv.h b/drivers/gpu/drm/i915/i915_drv.h index 0d1949a78c44..dc6c9f52d3a5 100644 --- a/drivers/gpu/drm/i915/i915_drv.h +++ b/drivers/gpu/drm/i915/i915_drv.h @@ -1225,7 +1225,7 @@ struct i915_perf_stream { struct i915_oa_config *oa_config; /** - * The OA context specific information. + * @pinned_ctx: The OA context specific information. */ struct intel_context *pinned_ctx; u32 specific_ctx_id; @@ -1239,7 +1239,7 @@ struct i915_perf_stream { int period_exponent; /** - * State of the OA buffer. + * @oa_buffer: State of the OA buffer. */ struct { struct i915_vma *vma; @@ -1250,7 +1250,7 @@ struct i915_perf_stream { int size_exponent; /** - * Locks reads and writes to all head/tail state + * @ptr_lock: Locks reads and writes to all head/tail state * * Consider: the head and tail pointer state needs to be read * consistently from a hrtimer callback (atomic context) and @@ -1272,8 +1272,8 @@ struct i915_perf_stream { spinlock_t ptr_lock; /** - * One 'aging' tail pointer and one 'aged' tail pointer ready to - * used for reading. + * @tails: One 'aging' tail pointer and one 'aged' tail pointer + * ready to used for reading. * * Initial values of 0xffffffff are invalid and imply that an * update is required (and should be ignored by an attempted @@ -1284,21 +1284,23 @@ struct i915_perf_stream { } tails[2]; /** - * Index for the aged tail ready to read() data up to. + * @aged_tail_idx: Index for the aged tail ready to read() data + * up to. */ unsigned int aged_tail_idx; /** - * A monotonic timestamp for when the current aging tail pointer - * was read; used to determine when it is old enough to trust. + * @aging_timestamp: A monotonic timestamp for when the current + * aging tail pointer was read; used to determine when it is old + * enough to trust. */ u64 aging_timestamp; /** - * Although we can always read back the head pointer register, - * we prefer to avoid trusting the HW state, just to avoid any - * risk that some hardware condition could * somehow bump the - * head pointer unpredictably and cause us to forward the wrong + * @head: Although we can always read back the head pointer + * register, we prefer to avoid trusting the HW state, just to + * avoid any risk that some hardware condition could somehow bump + * the head pointer unpredictably and cause us to forward the wrong * OA buffer data to userspace. */ u32 head;