From patchwork Thu Dec 21 03:20:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 181977 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp159503dyi; Wed, 20 Dec 2023 19:21:17 -0800 (PST) X-Google-Smtp-Source: AGHT+IFUsJilwCe0XgR19LRTrw/J6ZZiMSjVOeoDDRtvy0MwXvTNmwE9EKBQYAxCbsUGFUzJAhNP X-Received: by 2002:a17:906:5c1:b0:a26:89fc:1910 with SMTP id t1-20020a17090605c100b00a2689fc1910mr1344152ejt.134.1703128876888; Wed, 20 Dec 2023 19:21:16 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703128876; cv=none; d=google.com; s=arc-20160816; b=inVhxMfRzSjgqi97xct6ikYKU2CeJGfKL0HYyOi+xnjSA7SwJ/Y2sQPv+EEjQ1Fc8z oDFkc0uv1nI/TvXh03NRac7qJ9ZBqyO47HtKFSSSk3B3kr8Xj9B06mStdNhtf7UpJ88K JBT3OS9QmT0OAvTNd9Kp5toiq7bcXUGr99AVoKRcY8vcRVw0sm35+9Cz+D0AgQyv70O1 LuASoGmZh/X7TZ3SrDb/uKmoOtk4ghEezAHNLHertvuT7oNUaCD5sadFmDAd/otX7fgy 6HAnNCxp1LFznw7BoBUOFEBgHFEg8/T+mnXNbfa/JQaC90T+Eoj5BzrEoBqAqAuCg0F/ ZqQA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=Om7KGzS/g2Y7wQ9rvSrrGdz3FHj7wYsDCL1dsHV/Wu0=; fh=7C+om+4LAiL/I2vqDXHjdCv+GFuVkhSSXjorl92wcJo=; b=KNy0/iB85xXqhcGDbW0518intxgdfUoJRh5pZAtUsIjWYUFVuC7F6zFdKbEXdabKHQ ohqKQxv5x2/NFIhg4ZGzBbFKb/1r61timujZ7msyy9yK0Mf4SSu56CrtSOnYqfC2FG4U 4ah4CHQK6eeupFK8kIb4HcBYjnASPUwoYV0TVXY4R+Cd/9UE0m3TLJTqQr1kp41o7ZDU 275IpN87ANfXV3b+OKd/c7hw9CBRAaZuMNSUklH2SfRakPkCIvsOmWDoRPaboHKI57bM kc74LP9Pc7SBkhzR6s2XIf7+xLZHhFVtnuUtCCdeyb1FC3i31lARIMY4zOf95EoPivde OAUA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=d5zq35gg; spf=pass (google.com: domain of linux-kernel+bounces-7804-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7804-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id lv23-20020a170906bc9700b00a1db955c811si450953ejb.318.2023.12.20.19.21.16 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Dec 2023 19:21:16 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-7804-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=d5zq35gg; spf=pass (google.com: domain of linux-kernel+bounces-7804-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7804-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 81E571F229C8 for ; Thu, 21 Dec 2023 03:21:16 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id EFF5416413; Thu, 21 Dec 2023 03:20:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="d5zq35gg" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 9754EFBEA for ; Thu, 21 Dec 2023 03:20:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=Om7KGzS/g2Y7wQ9rvSrrGdz3FHj7wYsDCL1dsHV/Wu0=; b=d5zq35ggn427N91YatbcRRHKN0 btcolbNdCwea4DDkcdb1wfpYKzT/VxA7xPTpjEl/a8QCUHr20uiNrTAUAmXc12Zvf3wEeKliw4oD2 drCBHe+Kmkjwf4c7jLY4Qfm3hbHvq+jaglYk5prI062CenLStMBKcEjy/8QrLcwj2EGALGMcPiNsd W3hvUag1HDi8G/eQ5/REPo8QKGIgPGWSHT32TamJtNySJvbvH1fWe3m+BSHVVocY1wFExCXxI+Nah F1pYLuzY+kMSe5uYU7qaHs4gBdg96o/ckHNoWiWAwp57ZB7hvr9tBgfosWU3KPAIb2SUe2/+bfh4R NpQklf8A==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rG9br-001aN9-0c; Thu, 21 Dec 2023 03:20:31 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Jani Nikula , Joonas Lahtinen , Rodrigo Vivi , Tvrtko Ursulin , intel-gfx@lists.freedesktop.org, Jonathan Corbet , dri-devel@lists.freedesktop.org Subject: [PATCH 4/4] drm/i915/perf: reconcile Excess struct member kernel-doc warnings Date: Wed, 20 Dec 2023 19:20:29 -0800 Message-ID: <20231221032029.30942-4-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231221032029.30942-1-rdunlap@infradead.org> References: <20231221032029.30942-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785860064904346906 X-GMAIL-MSGID: 1785860064904346906 Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst. i915_perf_types.h:341: warning: Excess struct member 'ptr_lock' description in 'i915_perf_stream' i915_perf_types.h:341: warning: Excess struct member 'head' description in 'i915_perf_stream' i915_perf_types.h:341: warning: Excess struct member 'tail' description in 'i915_perf_stream' 3 warnings as Errors Signed-off-by: Randy Dunlap Cc: Jani Nikula Cc: Joonas Lahtinen Cc: Rodrigo Vivi Cc: Tvrtko Ursulin Cc: intel-gfx@lists.freedesktop.org Cc: Jonathan Corbet Cc: dri-devel@lists.freedesktop.org Reviewed-by: Rodrigo Vivi --- drivers/gpu/drm/i915/i915_perf_types.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff -- a/drivers/gpu/drm/i915/i915_perf_types.h b/drivers/gpu/drm/i915/i915_perf_types.h --- a/drivers/gpu/drm/i915/i915_perf_types.h +++ b/drivers/gpu/drm/i915/i915_perf_types.h @@ -291,7 +291,8 @@ struct i915_perf_stream { int size_exponent; /** - * @ptr_lock: Locks reads and writes to all head/tail state + * @oa_buffer.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 @@ -313,7 +314,8 @@ struct i915_perf_stream { spinlock_t ptr_lock; /** - * @head: Although we can always read back the head pointer register, + * @oa_buffer.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 @@ -322,7 +324,8 @@ struct i915_perf_stream { u32 head; /** - * @tail: The last verified tail that can be read by userspace. + * @oa_buffer.tail: The last verified tail that can be + * read by userspace. */ u32 tail; } oa_buffer;