diff mbox series

[v7] platform/chrome: cros_ec_lpc: Move host command to prepare/complete

Message ID 20220823095915.v7.1.I55189adfdb8d025fc991a0fa820ec09078619b15@changeid (mailing list archive)
State Superseded
Headers show
Series [v7] platform/chrome: cros_ec_lpc: Move host command to prepare/complete | expand

Commit Message

Tim Van Patten Aug. 23, 2022, 3:59 p.m. UTC
Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
.prepare() and cros_ec_lpc_complete() during .complete(). This moves the
host command that the AP sends and allows the EC to log entry/exit of
AP's suspend/resume more accurately.

Signed-off-by: Tim Van Patten <timvp@google.com>
---

Changes in v7:
- Rename "host event" to "host command" in title/description.

Changes in v6:
- Fully restore fixes from v3.

Changes in v5:
- Restore fixes from v3.

Changes in v4:
- Update title and description.

Changes in v3:
- Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
- Update cros_ec_lpc_resume() to cros_ec_lpc_complete()

Changes in v2:
- Include cros_ec_resume() return value in dev_info() output.
- Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.

 drivers/platform/chrome/cros_ec_lpc.c | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

Comments

Tim Van Patten Aug. 31, 2022, 6 p.m. UTC | #1
Hi,

Friendly ping on this patch.


On Tue, Aug 23, 2022 at 9:59 AM Tim Van Patten <timvp@google.com> wrote:
>
> Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
> .prepare() and cros_ec_lpc_complete() during .complete(). This moves the
> host command that the AP sends and allows the EC to log entry/exit of
> AP's suspend/resume more accurately.
>
> Signed-off-by: Tim Van Patten <timvp@google.com>
> ---
>
> Changes in v7:
> - Rename "host event" to "host command" in title/description.
>
> Changes in v6:
> - Fully restore fixes from v3.
>
> Changes in v5:
> - Restore fixes from v3.
>
> Changes in v4:
> - Update title and description.
>
> Changes in v3:
> - Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
> - Update cros_ec_lpc_resume() to cros_ec_lpc_complete()
>
> Changes in v2:
> - Include cros_ec_resume() return value in dev_info() output.
> - Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.
>
>  drivers/platform/chrome/cros_ec_lpc.c | 16 ++++++++++++----
>  1 file changed, 12 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/platform/chrome/cros_ec_lpc.c b/drivers/platform/chrome/cros_ec_lpc.c
> index 7677ab3c0ead..4158bdeee197 100644
> --- a/drivers/platform/chrome/cros_ec_lpc.c
> +++ b/drivers/platform/chrome/cros_ec_lpc.c
> @@ -530,23 +530,31 @@ static const struct dmi_system_id cros_ec_lpc_dmi_table[] __initconst = {
>  MODULE_DEVICE_TABLE(dmi, cros_ec_lpc_dmi_table);
>
>  #ifdef CONFIG_PM_SLEEP
> -static int cros_ec_lpc_suspend(struct device *dev)
> +static int cros_ec_lpc_prepare(struct device *dev)
>  {
>         struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
>
> +       dev_info(dev, "Prepare EC suspend\n");
> +
>         return cros_ec_suspend(ec_dev);
>  }
>
> -static int cros_ec_lpc_resume(struct device *dev)
> +static void cros_ec_lpc_complete(struct device *dev)
>  {
>         struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
> +       int ret;
> +
> +       ret = cros_ec_resume(ec_dev);
>
> -       return cros_ec_resume(ec_dev);
> +       dev_info(dev, "EC resume completed: ret = %d\n", ret);
>  }
>  #endif
>
>  static const struct dev_pm_ops cros_ec_lpc_pm_ops = {
> -       SET_LATE_SYSTEM_SLEEP_PM_OPS(cros_ec_lpc_suspend, cros_ec_lpc_resume)
> +#ifdef CONFIG_PM_SLEEP
> +       .prepare = cros_ec_lpc_prepare,
> +       .complete = cros_ec_lpc_complete
> +#endif
>  };
>
>  static struct platform_driver cros_ec_lpc_driver = {
> --
> 2.37.2.609.g9ff673ca1a-goog
>
Tzung-Bi Shih Sept. 1, 2022, 1:52 a.m. UTC | #2
On Wed, Aug 31, 2022 at 12:00:55PM -0600, Tim Van Patten wrote:
> Hi,
> 
> Friendly ping on this patch.

We don't top-post on Linux kernel mailing lists.

> On Tue, Aug 23, 2022 at 9:59 AM Tim Van Patten <timvp@google.com> wrote:
> >
> > Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
> > .prepare() and cros_ec_lpc_complete() during .complete(). This moves the
> > host command that the AP sends and allows the EC to log entry/exit of
> > AP's suspend/resume more accurately.
> >
> > Signed-off-by: Tim Van Patten <timvp@google.com>
> > ---
> >
> > Changes in v7:
> > - Rename "host event" to "host command" in title/description.
> >
> > Changes in v6:
> > - Fully restore fixes from v3.
> >
> > Changes in v5:
> > - Restore fixes from v3.
> >
> > Changes in v4:
> > - Update title and description.
> >
> > Changes in v3:
> > - Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
> > - Update cros_ec_lpc_resume() to cros_ec_lpc_complete()
> >
> > Changes in v2:
> > - Include cros_ec_resume() return value in dev_info() output.
> > - Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.

I don't buy-in the ideas from the discussion in v3[1].  Thus, I would defer
to other reviewers/maintainers on the list to seek their suggestions.

[1]: https://patchwork.kernel.org/project/chrome-platform/patch/20220802113957.v3.1.I2c8c550183162e7594309b66d19af696b8d84552@changeid/
Raul Rangel Sept. 1, 2022, 2:21 a.m. UTC | #3
On Wed, Aug 31, 2022 at 7:52 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
>
> On Wed, Aug 31, 2022 at 12:00:55PM -0600, Tim Van Patten wrote:
> > Hi,
> >
> > Friendly ping on this patch.
>
> We don't top-post on Linux kernel mailing lists.
>
> > On Tue, Aug 23, 2022 at 9:59 AM Tim Van Patten <timvp@google.com> wrote:
> > >
> > > Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
> > > .prepare() and cros_ec_lpc_complete() during .complete(). This moves the
> > > host command that the AP sends and allows the EC to log entry/exit of
> > > AP's suspend/resume more accurately.
> > >
> > > Signed-off-by: Tim Van Patten <timvp@google.com>
> > > ---
> > >
> > > Changes in v7:
> > > - Rename "host event" to "host command" in title/description.
> > >
> > > Changes in v6:
> > > - Fully restore fixes from v3.
> > >
> > > Changes in v5:
> > > - Restore fixes from v3.
> > >
> > > Changes in v4:
> > > - Update title and description.
> > >
> > > Changes in v3:
> > > - Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
> > > - Update cros_ec_lpc_resume() to cros_ec_lpc_complete()
> > >
> > > Changes in v2:
> > > - Include cros_ec_resume() return value in dev_info() output.
> > > - Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.
>

> I don't buy-in the ideas from the discussion in v3[1].  Thus, I would defer
> to other reviewers/maintainers on the list to seek their suggestions.
>
> [1]: https://patchwork.kernel.org/project/chrome-platform/patch/20220802113957.v3.1.I2c8c550183162e7594309b66d19af696b8d84552@changeid/

Just to clarify, you are opposed to printing the return code because
`cros_ec_resume` currently always returns 0? Or is there another
objection?
Tzung-Bi Shih Sept. 1, 2022, 2:44 a.m. UTC | #4
On Wed, Aug 31, 2022 at 08:21:23PM -0600, Raul Rangel wrote:
> On Wed, Aug 31, 2022 at 7:52 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
> > > On Tue, Aug 23, 2022 at 9:59 AM Tim Van Patten <timvp@google.com> wrote:
> > > >
> > > > Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
> > > > .prepare() and cros_ec_lpc_complete() during .complete(). This moves the
> > > > host command that the AP sends and allows the EC to log entry/exit of
> > > > AP's suspend/resume more accurately.
> > > >
> > > > Signed-off-by: Tim Van Patten <timvp@google.com>
> > > > ---
> > > >
> > > > Changes in v7:
> > > > - Rename "host event" to "host command" in title/description.
> > > >
> > > > Changes in v6:
> > > > - Fully restore fixes from v3.
> > > >
> > > > Changes in v5:
> > > > - Restore fixes from v3.
> > > >
> > > > Changes in v4:
> > > > - Update title and description.
> > > >
> > > > Changes in v3:
> > > > - Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
> > > > - Update cros_ec_lpc_resume() to cros_ec_lpc_complete()
> > > >
> > > > Changes in v2:
> > > > - Include cros_ec_resume() return value in dev_info() output.
> > > > - Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.
> >
> 
> > I don't buy-in the ideas from the discussion in v3[1].  Thus, I would defer
> > to other reviewers/maintainers on the list to seek their suggestions.
> >
> > [1]: https://patchwork.kernel.org/project/chrome-platform/patch/20220802113957.v3.1.I2c8c550183162e7594309b66d19af696b8d84552@changeid/
> 
> Just to clarify, you are opposed to printing the return code because
> `cros_ec_resume` currently always returns 0? Or is there another
> objection?

Yes.  I'm not sure if always printing 0 is a good idea.
Tim Van Patten Sept. 1, 2022, 3:50 p.m. UTC | #5
On Wed, Aug 31, 2022 at 8:44 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
>
> On Wed, Aug 31, 2022 at 08:21:23PM -0600, Raul Rangel wrote:
> > On Wed, Aug 31, 2022 at 7:52 PM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
> > > > On Tue, Aug 23, 2022 at 9:59 AM Tim Van Patten <timvp@google.com> wrote:
> > > > >
> > > > > Update cros_ec_lpc_pm_ops to call cros_ec_lpc_prepare() during PM
> > > > > .prepare() and cros_ec_lpc_complete() during .complete(). This moves the
> > > > > host command that the AP sends and allows the EC to log entry/exit of
> > > > > AP's suspend/resume more accurately.
> > > > >
> > > > > Signed-off-by: Tim Van Patten <timvp@google.com>
> > > > > ---
> > > > >
> > > > > Changes in v7:
> > > > > - Rename "host event" to "host command" in title/description.
> > > > >
> > > > > Changes in v6:
> > > > > - Fully restore fixes from v3.
> > > > >
> > > > > Changes in v5:
> > > > > - Restore fixes from v3.
> > > > >
> > > > > Changes in v4:
> > > > > - Update title and description.
> > > > >
> > > > > Changes in v3:
> > > > > - Update cros_ec_lpc_suspend() to cros_ec_lpc_prepare()
> > > > > - Update cros_ec_lpc_resume() to cros_ec_lpc_complete()
> > > > >
> > > > > Changes in v2:
> > > > > - Include cros_ec_resume() return value in dev_info() output.
> > > > > - Guard setting .prepare/.complete with #ifdef CONFIG_PM_SLEEP.
> > >
> >
> > > I don't buy-in the ideas from the discussion in v3[1].  Thus, I would defer
> > > to other reviewers/maintainers on the list to seek their suggestions.
> > >
> > > [1]: https://patchwork.kernel.org/project/chrome-platform/patch/20220802113957.v3.1.I2c8c550183162e7594309b66d19af696b8d84552@changeid/
> >
> > Just to clarify, you are opposed to printing the return code because
> > `cros_ec_resume` currently always returns 0? Or is there another
> > objection?
>
> Yes.  I'm not sure if always printing 0 is a good idea.

We want the print statements to know when the EC sees suspend/resume
start/complete.   Having two versions of the same print statement, but
picking the correct one based on whether the return value is non-zero
is a bad design, which is why it always prints the return value.
Ignoring the return value entirely is also a bad design, since it can
change in the future. For example if cros_ec_resume() is updated to
pass along a bad return value instead of swallowing it always
returning 0.
diff mbox series

Patch

diff --git a/drivers/platform/chrome/cros_ec_lpc.c b/drivers/platform/chrome/cros_ec_lpc.c
index 7677ab3c0ead..4158bdeee197 100644
--- a/drivers/platform/chrome/cros_ec_lpc.c
+++ b/drivers/platform/chrome/cros_ec_lpc.c
@@ -530,23 +530,31 @@  static const struct dmi_system_id cros_ec_lpc_dmi_table[] __initconst = {
 MODULE_DEVICE_TABLE(dmi, cros_ec_lpc_dmi_table);
 
 #ifdef CONFIG_PM_SLEEP
-static int cros_ec_lpc_suspend(struct device *dev)
+static int cros_ec_lpc_prepare(struct device *dev)
 {
 	struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
 
+	dev_info(dev, "Prepare EC suspend\n");
+
 	return cros_ec_suspend(ec_dev);
 }
 
-static int cros_ec_lpc_resume(struct device *dev)
+static void cros_ec_lpc_complete(struct device *dev)
 {
 	struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
+	int ret;
+
+	ret = cros_ec_resume(ec_dev);
 
-	return cros_ec_resume(ec_dev);
+	dev_info(dev, "EC resume completed: ret = %d\n", ret);
 }
 #endif
 
 static const struct dev_pm_ops cros_ec_lpc_pm_ops = {
-	SET_LATE_SYSTEM_SLEEP_PM_OPS(cros_ec_lpc_suspend, cros_ec_lpc_resume)
+#ifdef CONFIG_PM_SLEEP
+	.prepare = cros_ec_lpc_prepare,
+	.complete = cros_ec_lpc_complete
+#endif
 };
 
 static struct platform_driver cros_ec_lpc_driver = {