| Message ID | 20230111055728.708990-3-tzungbi@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 20eb556dac27427f951ca13e117d32bd1c041b79 |
| 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 warning: > > $ ./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 'suspend_timeout_ms' not described in 'cros_ec_device' > > Cc: Evan Green <evgreen@chromium.org> > Fixes: e8bf17d58a4d ("platform/chrome: cros_ec: Expose suspend_timeout_ms in debugfs") > Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org> Reviewed-by: Guenter Roeck <groeck@chromium.org> > --- > include/linux/platform_data/cros_ec_proto.h | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h > index a4a3fec15504..805dcb19a36d 100644 > --- a/include/linux/platform_data/cros_ec_proto.h > +++ b/include/linux/platform_data/cros_ec_proto.h > @@ -131,6 +131,11 @@ struct cros_ec_command { > * @event_data: Raw payload transferred with the MKBP event. > * @event_size: Size in bytes of the event data. > * @host_event_wake_mask: Mask of host events that cause wake from suspend. > + * @suspend_timeout_ms: The timeout in milliseconds between when sleep event > + * is received and when the EC will declare sleep > + * transition failure if the sleep signal is not > + * asserted. See also struct > + * ec_params_host_sleep_event_v1 in cros_ec_commands.h. > * @last_event_time: exact time from the hard irq when we got notified of > * a new event. > * @notifier_ready: The notifier_block to let the kernel re-query EC > -- > 2.39.0.314.g84b9a713c41-goog >
diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h index a4a3fec15504..805dcb19a36d 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -131,6 +131,11 @@ struct cros_ec_command { * @event_data: Raw payload transferred with the MKBP event. * @event_size: Size in bytes of the event data. * @host_event_wake_mask: Mask of host events that cause wake from suspend. + * @suspend_timeout_ms: The timeout in milliseconds between when sleep event + * is received and when the EC will declare sleep + * transition failure if the sleep signal is not + * asserted. See also struct + * ec_params_host_sleep_event_v1 in cros_ec_commands.h. * @last_event_time: exact time from the hard irq when we got notified of * a new event. * @notifier_ready: The notifier_block to let the kernel re-query EC
Fix the following kernel-doc warning: $ ./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 'suspend_timeout_ms' not described in 'cros_ec_device' Cc: Evan Green <evgreen@chromium.org> Fixes: e8bf17d58a4d ("platform/chrome: cros_ec: Expose suspend_timeout_ms in debugfs") Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org> --- include/linux/platform_data/cros_ec_proto.h | 5 +++++ 1 file changed, 5 insertions(+)