| Message ID | 20230111055728.708990-4-tzungbi@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 212c9b9c395f72fd83c10cf2692b9562c2110d0f |
| Headers | show |
| Series | platform/chrome: fix kernel-doc warnings | expand |
On Tue, Jan 10, 2023 at 9:58 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 'last_resume_result' not described in 'cros_ec_device' > > Cc: Evan Green <evgreen@chromium.org> > Fixes: 8c3166e17cf1 ("mfd / platform: cros_ec_debugfs: Expose resume result via 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 | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h > index 805dcb19a36d..4865c54d4af1 100644 > --- a/include/linux/platform_data/cros_ec_proto.h > +++ b/include/linux/platform_data/cros_ec_proto.h > @@ -136,6 +136,10 @@ struct cros_ec_command { > * transition failure if the sleep signal is not > * asserted. See also struct > * ec_params_host_sleep_event_v1 in cros_ec_commands.h. > + * @last_resume_result: The number of sleep power signal transitions that > + * occurred since the suspend message. The high bit > + * indicates a timeout occurred. See also struct > + * ec_response_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 805dcb19a36d..4865c54d4af1 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -136,6 +136,10 @@ struct cros_ec_command { * transition failure if the sleep signal is not * asserted. See also struct * ec_params_host_sleep_event_v1 in cros_ec_commands.h. + * @last_resume_result: The number of sleep power signal transitions that + * occurred since the suspend message. The high bit + * indicates a timeout occurred. See also struct + * ec_response_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 'last_resume_result' not described in 'cros_ec_device' Cc: Evan Green <evgreen@chromium.org> Fixes: 8c3166e17cf1 ("mfd / platform: cros_ec_debugfs: Expose resume result via debugfs") Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org> --- include/linux/platform_data/cros_ec_proto.h | 4 ++++ 1 file changed, 4 insertions(+)