Skip to content

Commit 20eb556

Browse files
author
Tzung-Bi Shih
committed
platform/chrome: fix kernel-doc warning for suspend_timeout_ms
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 <[email protected]> Fixes: e8bf17d ("platform/chrome: cros_ec: Expose suspend_timeout_ms in debugfs") Signed-off-by: Tzung-Bi Shih <[email protected]> Reviewed-by: Guenter Roeck <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 16d7312 commit 20eb556

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

include/linux/platform_data/cros_ec_proto.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,11 @@ struct cros_ec_command {
131131
* @event_data: Raw payload transferred with the MKBP event.
132132
* @event_size: Size in bytes of the event data.
133133
* @host_event_wake_mask: Mask of host events that cause wake from suspend.
134+
* @suspend_timeout_ms: The timeout in milliseconds between when sleep event
135+
* is received and when the EC will declare sleep
136+
* transition failure if the sleep signal is not
137+
* asserted. See also struct
138+
* ec_params_host_sleep_event_v1 in cros_ec_commands.h.
134139
* @last_event_time: exact time from the hard irq when we got notified of
135140
* a new event.
136141
* @notifier_ready: The notifier_block to let the kernel re-query EC

0 commit comments

Comments
 (0)