From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 A3A0B2E7647 for ; Fri, 14 Nov 2025 18:58:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763146708; cv=none; b=FJcDmbZJBs3pQGKxDwqtcyk56APdo4Nf8tZqeGsv70MqmegtaqrGO9c24tKCrLBuvXCF/n3IXeM1o+gUWEX2NcTvxhBTxrTXR6AXXVnxFPdQuj0IvTanklbfQg4Nk4MO5JnV/HTuJ6WvhkbJGcLJsu9MgF/udApMLVlfqZu6q9E= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763146708; c=relaxed/simple; bh=BlwOUAnCr2/jw9ThwXHHNSy1eG4rDyfOn9fXPfHKYjw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=UQKsm7MhZT1LmVswGF24rOsBYk1lI9IeBrA5ePogvDDU5J7s4Azp8SBQEdABFOPdRU8cXTU4emd5AiMprBVmGP2i6+uppW3VmMNtVTlZC0ztli7EN2XF4zb3l4Xw8CUiScULYS0rHUBHw0V46D9ZcWtvCP/S1Z8dAU9OD+1oAI4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DucYAJSU; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="DucYAJSU" Received: by smtp.kernel.org (Postfix) with ESMTPSA id E0444C19425; Fri, 14 Nov 2025 18:58:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1763146708; bh=BlwOUAnCr2/jw9ThwXHHNSy1eG4rDyfOn9fXPfHKYjw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DucYAJSUz7Zbz9t+YqJMTYLidbtx0TkDilwa9t89lpZEPTur+GE3uC+CC91+eyEjO 4vqV+aodx9gh7bjYTeiiUWR403lRqBOsHCxaRCCReNsoiroeY1jKG3+3VqWd1QrbhN u4fFqWbMlQBG6m3cdu/cUfVqZV+4KMtF0J5qcLr7tUBPtG8zyZgxmuDomfVQJ5xoAi 451Rl4u94FOL4TWBX60n99Mspkqt8e2CSHeN1+ChG1/qTTjgrkJRvtfrmQR7vu2k4h JRUup6D2dNMffKBcFGgy7/IzZVz3TwRgCZPG8BWyfr1NwLGkhBDPbkBch/dmcJljgl xbkJF3e/1lfHQ== From: Dinh Nguyen To: linux-kernel@vger.kernel.org Cc: dinguyen@kernel.org, gregkh@linuxfoundation.org, arnd@arndb.de, Stephen Rothwell Subject: [PATCH 3/3] firmware: stratix10-svc: fix make htmldocs warning Date: Fri, 14 Nov 2025 12:58:15 -0600 Message-ID: <20251114185815.358423-3-dinguyen@kernel.org> X-Mailer: git-send-email 2.42.0.411.g813d9a9188 In-Reply-To: <20251114185815.358423-1-dinguyen@kernel.org> References: <20251114185815.358423-1-dinguyen@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Stephen Rothwell reports htmldocs warnings when merging char-misc tree: WARNING: include/linux/firmware/intel/stratix10-svc-client.h:22 This comment starts with '/**', but isn't a kernel-doc comment. WARNING: include/linux/firmware/intel/stratix10-svc-client.h:184 Enum value 'COMMAND_HWMON_READTEMP' not described in enum 'stratix10_svc_command_code' WARNING: include/linux/firmware/intel/stratix10-svc-client.h:184 Enum value 'COMMAND_HWMON_READVOLT' not described in enum 'stratix10_svc_command_code' WARNING: include/linux/firmware/intel/stratix10-svc-client.h:307 function parameter 'cb_arg' not described in 'async_callback_t' Fixes: 4f49088c1625 ("firmware: stratix10-svc: Add definition for voltage and temperature sensor") Reported-by: Stephen Rothwell Closes: https://lore.kernel.org/linux-next/20251114153920.1c5df700@canb.auug.org.au/ Signed-off-by: Dinh Nguyen --- include/linux/firmware/intel/stratix10-svc-client.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h index 1bcc56d14080..d290060f4c73 100644 --- a/include/linux/firmware/intel/stratix10-svc-client.h +++ b/include/linux/firmware/intel/stratix10-svc-client.h @@ -19,7 +19,7 @@ #define SVC_CLIENT_FCS "fcs" #define SVC_CLIENT_HWMON "hwmon" -/** +/* * Status of the sent command, in bit number * * SVC_STATUS_OK: @@ -148,6 +148,12 @@ struct stratix10_svc_chan; * * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status * is SVC_STATUS_OK, SVC_STATUS_ERROR + * + * @COMMAND_HWMON_READTEMP: query the temperature from the hardware monitor, + * return status is SVC_STATUS_OK or SVC_STATUS_ERROR + * + * @COMMAND_HWMON_READVOLT: query the voltage from the hardware monitor, + * return status is SVC_STATUS_OK or SVC_STATUS_ERROR */ enum stratix10_svc_command_code { /* for FPGA */ @@ -303,7 +309,7 @@ void stratix10_svc_done(struct stratix10_svc_chan *chan); * The callback function takes a single argument, which is a pointer to * user-defined data. * - * @param cb_arg A pointer to user-defined data passed to the callback function. + * @cb_arg: Argument to be passed to the callback function. */ typedef void (*async_callback_t)(void *cb_arg); -- 2.42.0.411.g813d9a9188