From patchwork Thu Dec 28 23:49:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13506239 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org 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 smtp.lore.kernel.org (Postfix) with ESMTPS id D5723C46CD3 for ; Thu, 28 Dec 2023 23:49:48 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 4D5A310E27B; Thu, 28 Dec 2023 23:49:48 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id E76CC10E27B; Thu, 28 Dec 2023 23:49:47 +0000 (UTC) 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:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=CaD1scPgCP6kIN7T4P7A8QdN++h5vz9R+z+vQqZZTd0=; b=mL+chwnB2GJ3qbZ7OdM6WUpPrV DTqoHYfpYMzxVURin3bv6MOz25/JeQ42ZqL1wSPCiXYhOhok0QEg6g2At+21woAJpweR+v8lX4OhA VPUgFlmUjNo5zcTGBpRen2yDwN8m3FnRgzMkyOu4J8FqtQeZWFKL1bHE9eqoI6u2HA/u9TDCsHty8 JpbCVq9dna+XLrgqoIE34+wLTfPKpqLAcQBFCUPJe8skllX7vbmKveoPyA321KrybVCuppaSBcle5 CT/8TSJ3hHiSw5S140I1p1D4Jf07JqaZP8cLVgoJ7RpjGajXwpQIRCj1QAqyRaxPPqz8EZK7d8G0s +GPFBS8g==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rJ08I-00HYK1-30; Thu, 28 Dec 2023 23:49:46 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Subject: [PATCH v2.1 2/4] drm/i915/gt: reconcile Excess struct member kernel-doc warnings Date: Thu, 28 Dec 2023 15:49:46 -0800 Message-ID: <20231228234946.12405-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Randy Dunlap , Jonathan Corbet , intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, Rodrigo Vivi Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst. intel_gsc.h:34: warning: Excess struct member 'gem_obj' description in 'intel_gsc' Also add missing field member descriptions. 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 Cc: Andi Shyti --- v2: add Reviewed-by: Rodrigo rebase and resend due to (i915) patchwork being down v2.1: reformat to be consistent with kernel-doc in other files (Andi) Please let me know if I should resend all 4 patches as v3. drivers/gpu/drm/i915/gt/intel_gsc.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff -- a/drivers/gpu/drm/i915/gt/intel_gsc.h b/drivers/gpu/drm/i915/gt/intel_gsc.h --- a/drivers/gpu/drm/i915/gt/intel_gsc.h +++ b/drivers/gpu/drm/i915/gt/intel_gsc.h @@ -21,8 +21,11 @@ struct mei_aux_device; /** * struct intel_gsc - graphics security controller * - * @gem_obj: scratch memory GSC operations - * @intf : gsc interface + * @intf: gsc interface + * @intf.adev: MEI aux. device for this @intf + * @intf.gem_obj: scratch memory GSC operations + * @intf.irq: IRQ for this device (%-1 for no IRQ) + * @intf.id: this interface's id number/index */ struct intel_gsc { struct intel_gsc_intf {