Re: [PATCH] PM: sleep: Add kerneldoc comments to some functions

From: Christoph Hellwig
Date: Mon May 20 2019 - 02:05:23 EST


>
> +/**
> + * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
> + *
> + * To be called during system-wide power management transitions to sleep states.
> + *
> + * Return 'true' if the platform firmware is going to be invoked at the end of
> + * the system-wide power management transition in progress in order to complete
> + * it.
> + */

Ok, so this only returns true if the firmware gets invoked for this
particular transition we are currently in. That was my main confusion
here. Also any chance to add an example of why this might matter?