Commit 16d73129 authored Jan 11, 2023 by Tzung-Bi Shih

platform/chrome: fix kernel-doc warnings for panic notifier



Fix the following kernel-doc warnings:

$ ./scripts/kernel-doc -none drivers/platform/chrome/*
drivers/platform/chrome/cros_ec_debugfs.c:54: warning: Function
parameter or member 'notifier_panic' not described in 'cros_ec_debugfs'

$ ./scripts/kernel-doc -none include/linux/platform_data/cros_ec_proto.h
include/linux/platform_data/cros_ec_proto.h:187: warning: Function
parameter or member 'panic_notifier' not described in 'cros_ec_device'

Cc: Rob Barnes <robbarnes@google.com>
Fixes: d90fa2c6 ("platform/chrome: cros_ec: Poll EC log on EC panic")
Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
Reviewed-by: Guenter Roeck <groweck@chromium.org>
Link: https://lore.kernel.org/r/20230111055728.708990-2-tzungbi@kernel.org

parent 2ae3c610

drivers/platform/chrome/cros_ec_debugfs.c

+2 −0

Original line number	Diff line number	Diff line
		@@ -38,6 +38,8 @@ static DECLARE_WAIT_QUEUE_HEAD(cros_ec_debugfs_log_wq);
		* @log_mutex: mutex to protect circular buffer
		* @log_poll_work: recurring task to poll EC for new console log data
		* @panicinfo_blob: panicinfo debugfs blob
		* @notifier_panic: notifier_block to let kernel to flush buffered log
		* when EC panic
		*/
		struct cros_ec_debugfs {
		struct cros_ec_dev *ec;

include/linux/platform_data/cros_ec_proto.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -140,6 +140,7 @@ struct cros_ec_command {
		* main EC.
		* @pd: The platform_device used by the mfd driver to interface with the
		* PD behind an EC.
		* @panic_notifier: EC panic notifier.
		*/
		struct cros_ec_device {
		/* These are used by other drivers that want to talk to the EC */