From: Tzung-Bi Shih <tzungbi@kernel.org>
To: bleung@chromium.org, groeck@chromium.org
Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org,
Evan Green <evgreen@chromium.org>
Subject: [PATCH 2/4] platform/chrome: fix kernel-doc warning for suspend_timeout_ms
Date: Wed, 11 Jan 2023 13:57:26 +0800 [thread overview]
Message-ID: <20230111055728.708990-3-tzungbi@kernel.org> (raw)
In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org>
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(+)
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
next prev parent reply other threads:[~2023-01-11 5:57 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-11 5:57 [PATCH 0/4] platform/chrome: fix kernel-doc warnings Tzung-Bi Shih
2023-01-11 5:57 ` [PATCH 1/4] platform/chrome: fix kernel-doc warnings for panic notifier Tzung-Bi Shih
2023-01-11 16:30 ` Guenter Roeck
2023-01-11 5:57 ` Tzung-Bi Shih [this message]
2023-01-11 16:31 ` [PATCH 2/4] platform/chrome: fix kernel-doc warning for suspend_timeout_ms Guenter Roeck
2023-01-11 5:57 ` [PATCH 3/4] platform/chrome: fix kernel-doc warning for last_resume_result Tzung-Bi Shih
2023-01-11 16:31 ` Guenter Roeck
2023-01-11 5:57 ` [PATCH 4/4] platform/chrome: fix kernel-doc warnings for cros_ec_command Tzung-Bi Shih
2023-01-11 16:32 ` Guenter Roeck
2023-01-13 21:20 ` [PATCH 0/4] platform/chrome: fix kernel-doc warnings patchwork-bot+chrome-platform
2023-01-15 12:50 ` patchwork-bot+chrome-platform
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230111055728.708990-3-tzungbi@kernel.org \
--to=tzungbi@kernel.org \
--cc=bleung@chromium.org \
--cc=chrome-platform@lists.linux.dev \
--cc=evgreen@chromium.org \
--cc=groeck@chromium.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox