| Message ID | 20230111055728.708990-2-tzungbi@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 16d73129f1fd8e91eb565482245233809647c649 |
| Headers | show |
| Series | platform/chrome: fix kernel-doc warnings | expand |
On Tue, Jan 10, 2023 at 9:57 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote: > > 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: d90fa2c64d59 ("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> > --- > drivers/platform/chrome/cros_ec_debugfs.c | 2 ++ > include/linux/platform_data/cros_ec_proto.h | 1 + > 2 files changed, 3 insertions(+) > > diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c > index 34f7b46f8761..a98c529d8c69 100644 > --- a/drivers/platform/chrome/cros_ec_debugfs.c > +++ b/drivers/platform/chrome/cros_ec_debugfs.c > @@ -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; > diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h > index 017d502ed66e..a4a3fec15504 100644 > --- a/include/linux/platform_data/cros_ec_proto.h > +++ b/include/linux/platform_data/cros_ec_proto.h > @@ -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 */ > -- > 2.39.0.314.g84b9a713c41-goog >
diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c index 34f7b46f8761..a98c529d8c69 100644 --- a/drivers/platform/chrome/cros_ec_debugfs.c +++ b/drivers/platform/chrome/cros_ec_debugfs.c @@ -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; diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h index 017d502ed66e..a4a3fec15504 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -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 */
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: d90fa2c64d59 ("platform/chrome: cros_ec: Poll EC log on EC panic") Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org> --- drivers/platform/chrome/cros_ec_debugfs.c | 2 ++ include/linux/platform_data/cros_ec_proto.h | 1 + 2 files changed, 3 insertions(+)