From patchwork Tue Dec 26 19:54:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 183363 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:6f82:b0:100:9c79:88ff with SMTP id tb2csp1067525dyb; Tue, 26 Dec 2023 11:55:30 -0800 (PST) X-Google-Smtp-Source: AGHT+IHSzjgIc6eYzODWQY9rpN5Oy90uyxwmfCI85YW38UOQntULXcWikBmLEt6tGqwV9lEE1Sza X-Received: by 2002:a05:6e02:16cb:b0:35f:e284:f313 with SMTP id 11-20020a056e0216cb00b0035fe284f313mr10103705ilx.22.1703620530182; Tue, 26 Dec 2023 11:55:30 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703620530; cv=none; d=google.com; s=arc-20160816; b=sV87pKpsMtU5SSoaymGrRg8AEgvK/PBHMJ5vclsDYPU2sEGZtuzES9YNwAJTJAPfeN ItKvZ0dyTatvuBOTp2nECG8mA2mlhy3nJiZK7aB/Fn9kcDnuhhdXtorIRAqTcKTFNkDe uUOGAwrbePJKEobGQPiTe0AP+VlGuQys69N9s710QOz8wHWw3yAYe0mTX6r/Sl/b9qMu q+//J5gNUTv2AlQiKisGuILprJZzgoh+62VP6Dr3+DCEL1fZj3jKymA0u3qoRPIVOI8k hY6TdIdjpIA0nCUGIPRxK+qrvCklklKNr0gd+iDKgVZ+Fz0dXTg30gY2e14pKYLPZVfP Nk3g== 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=kbak+tkdOphm7pOnXQJacjOhwbUh9eBNBikt9IYgrdA=; fh=7C+om+4LAiL/I2vqDXHjdCv+GFuVkhSSXjorl92wcJo=; b=Qr+vifPnuoA0tQgw9FnmRyET0H19s5LJ2tjt4U6yywOGP67fAvca4cxWmi3mDIE6CW 0Tc9KgR9IVaZ4uH5pI4Qk8ZNQlUdBm2RdCkeQMUgl2JGHufQKxrID4PA1/CoHlmEHNXz g2LOBfxGOl9KXHkAjBfDcvCSyL1omOkxcF99W6lSFz5GSoLL4hT3+zrVwgPd2hnQR3Gx eVuOd1gNyiIFPuA+3S/XHi4LhIMTEb6N3+ZJ36Cs9rzGH2wJaX7NH4kv3zjc/vWLS15Z ttBlepMiQl/zfvA+ZLzZafovc0tN6ee006ZE4egU4Ug9jAjnxst0GTwusGNcOfgXGATx lehA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=L7A01Hb4; spf=pass (google.com: domain of linux-kernel+bounces-11662-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-11662-ouuuleilei=gmail.com@vger.kernel.org" Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id p9-20020a1709027ec900b001d42405877bsi7198562plb.621.2023.12.26.11.55.30 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 26 Dec 2023 11:55:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-11662-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=L7A01Hb4; spf=pass (google.com: domain of linux-kernel+bounces-11662-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-11662-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 sv.mirrors.kernel.org (Postfix) with ESMTPS id E6401281C43 for ; Tue, 26 Dec 2023 19:55:29 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id E6586107B1; Tue, 26 Dec 2023 19:54:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="L7A01Hb4" 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 0AFD31FC1 for ; Tue, 26 Dec 2023 19:54:34 +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=kbak+tkdOphm7pOnXQJacjOhwbUh9eBNBikt9IYgrdA=; b=L7A01Hb4nszrlt9e32q1vX+Lc8 /1U28L4lMov1uE+rN+fF9U2UIAif0C/8LHPE4e45CMcsGfNR6mjUuBw7Us/c32yCzsHFzdHBbvGf+ 5iCg/Q7aCoR6EkgG6xa0ZSbHYZps6DJLzOXUnqMbU87VFkhHURQUTWSjM+U7YjpCcFFiq2v7JYAm/ YUakzvoPYkLc9DSfWbm9K2VLqcb87cZ5S7cdaRq23w7OaM6aCjq/q3n+Yz1lfjexQ3URhU0qgq/+H EmJSCF17+XhHjBtf0j8yG+fTgf1o3J6srSaVrPeTMClOgDvweZpuYufimbtHKJPY8ca9E7kn1P5IW ywxC0jFw==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rIDVa-00DT1I-1H; Tue, 26 Dec 2023 19:54:34 +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 v2 4/4] drm/i915/perf: reconcile Excess struct member kernel-doc warnings Date: Tue, 26 Dec 2023 11:54:32 -0800 Message-ID: <20231226195432.10891-4-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231226195432.10891-1-rdunlap@infradead.org> References: <20231226195432.10891-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: 1786375600548488296 X-GMAIL-MSGID: 1786375600548488296 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 Reviewed-by: Andi Shyti --- v2: add Reviewed-by: Rodrigo rebase and resend due to (i915) patchwork being down 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;