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 3/4] platform/chrome: fix kernel-doc warning for last_resume_result
Date: Wed, 11 Jan 2023 13:57:27 +0800 [thread overview]
Message-ID: <20230111055728.708990-4-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 '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(+)
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
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 ` [PATCH 2/4] platform/chrome: fix kernel-doc warning for suspend_timeout_ms Tzung-Bi Shih
2023-01-11 16:31 ` Guenter Roeck
2023-01-11 5:57 ` Tzung-Bi Shih [this message]
2023-01-11 16:31 ` [PATCH 3/4] platform/chrome: fix kernel-doc warning for last_resume_result 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-4-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.