From patchwork Wed Feb 21 06:21:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13564976 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 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.lore.kernel.org (Postfix) with ESMTPS id 9CADCC48BF6 for ; Wed, 21 Feb 2024 06:22:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-ID:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=QqeYUaGFL8lVUDK7BzYKuJddebdeuignfFDi42mKkpY=; b=rhlnSd/7bxYtKq 3S9pvwEUATvZr4PNsmZwFahqQR3OL1tRhFDOQeWwuJ4z9sGwuDk9rWvVOxLVl73yiY0pTLv85s3Pu 0LPzc4nHWVyTSpxOCkU8lE8BPhdpLz1m9Y7lqWqgke9mtQO/1CHUxm9kBrDTJxQa2wRJuTevJbVMP Js++yjS/ihvF6vSBbTMqDarcazUEs1KRXI7QKWL1Jc9rPG+Fw+iOIsjh0Jcbuj5JSp+j6lalmMux0 FO+frdLPp1pvne1aXEduyMag6S4foWgIQCJgtD6diXiBMftcSjlhW/kKX4W+GfNhK/HPWxYRd20iw t84HUwU5aelOGu1uSiSw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rcfzT-0000000HJet-3oSE; Wed, 21 Feb 2024 06:21:59 +0000 Received: from [50.53.50.0] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rcfzS-0000000HJed-0pKJ; Wed, 21 Feb 2024 06:21:58 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Sudeep Holla , Cristian Marussi , linux-arm-kernel@lists.infradead.org Subject: [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings Date: Tue, 20 Feb 2024 22:21:57 -0800 Message-ID: <20240221062157.8694-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.1 MIME-Version: 1.0 X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Fix the kernel-doc notation for the nested union in struct scmi_optee_channel to eliminate kerenl-doc warnings: optee.c:130: warning: Excess struct member 'shmem' description in 'scmi_optee_channel' optee.c:131: warning: Function parameter or struct member 'req' not described in 'scmi_optee_channel' Signed-off-by: Randy Dunlap Cc: Sudeep Holla Cc: Cristian Marussi Cc: linux-arm-kernel@lists.infradead.org Reviewed-by: Cristian Marussi --- drivers/firmware/arm_scmi/optee.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff -- a/drivers/firmware/arm_scmi/optee.c b/drivers/firmware/arm_scmi/optee.c --- a/drivers/firmware/arm_scmi/optee.c +++ b/drivers/firmware/arm_scmi/optee.c @@ -109,8 +109,10 @@ enum scmi_optee_pta_cmd { * @rx_len: Response size * @mu: Mutex protection on channel access * @cinfo: SCMI channel information - * @shmem: Virtual base address of the shared memory - * @req: Shared memory protocol handle for SCMI request and synchronous response + * @req: union for SCMI interface + * @req.shmem: Virtual base address of the shared memory + * @req.msg: Shared memory protocol handle for SCMI request and + * synchronous response * @tee_shm: TEE shared memory handle @req or NULL if using IOMEM shmem * @link: Reference in agent's channel list */