Fixes the following W=1 kernel build warning(s):
arch/x86/power/cpu.c:76: warning: Function parameter or
member 'ctxt' not described in '__save_processor_state'
arch/x86/power/cpu.c:192: warning: Function parameter or
member 'ctxt' not described in '__restore_processor_state'
Signed-off-by: Baokun Li <[email protected]>
---
V1->V2:
Fix the formatting of this kerneldoc comment
arch/x86/power/cpu.c | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
index 3a070e7cdb8b..54b530db5ed0 100644
--- a/arch/x86/power/cpu.c
+++ b/arch/x86/power/cpu.c
@@ -58,19 +58,20 @@ static void msr_restore_context(struct saved_context *ctxt)
}
/**
- * __save_processor_state - save CPU registers before creating a
- * hibernation image and before restoring the memory state from it
- * @ctxt - structure to store the registers contents in
+ * __save_processor_statei() - Save CPU registers before creating a
+ * hibernation image and before restoring
+ * the memory state from it
+ * @ctxt: Structure to store the registers contents in.
*
- * NOTE: If there is a CPU register the modification of which by the
- * boot kernel (ie. the kernel used for loading the hibernation image)
- * might affect the operations of the restored target kernel (ie. the one
- * saved in the hibernation image), then its contents must be saved by this
- * function. In other words, if kernel A is hibernated and different
- * kernel B is used for loading the hibernation image into memory, the
- * kernel A's __save_processor_state() function must save all registers
- * needed by kernel A, so that it can operate correctly after the resume
- * regardless of what kernel B does in the meantime.
+ * NOTE: If there is a CPU register the modification of which by the
+ * boot kernel (ie. the kernel used for loading the hibernation image)
+ * might affect the operations of the restored target kernel (ie. the one
+ * saved in the hibernation image), then its contents must be saved by this
+ * function. In other words, if kernel A is hibernated and different
+ * kernel B is used for loading the hibernation image into memory, the
+ * kernel A's __save_processor_state() function must save all registers
+ * needed by kernel A, so that it can operate correctly after the resume
+ * regardless of what kernel B does in the meantime.
*/
static void __save_processor_state(struct saved_context *ctxt)
{
@@ -181,9 +182,9 @@ static void fix_processor_context(void)
}
/**
- * __restore_processor_state - restore the contents of CPU registers saved
- * by __save_processor_state()
- * @ctxt - structure to load the registers contents from
+ * __restore_processor_state() - Restore the contents of CPU registers saved
+ * by __save_processor_state()
+ * @ctxt: Structure to load the registers contents from.
*
* The asm code that gets us here will have restored a usable GDT, although
* it will be pointing to the wrong alias.
--
2.31.1
On Tue, Jun 15, 2021 at 5:26 AM Baokun Li <[email protected]> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> arch/x86/power/cpu.c:76: warning: Function parameter or
> member 'ctxt' not described in '__save_processor_state'
> arch/x86/power/cpu.c:192: warning: Function parameter or
> member 'ctxt' not described in '__restore_processor_state'
>
> Signed-off-by: Baokun Li <[email protected]>
> ---
> V1->V2:
> Fix the formatting of this kerneldoc comment
>
> arch/x86/power/cpu.c | 31 ++++++++++++++++---------------
> 1 file changed, 16 insertions(+), 15 deletions(-)
>
> diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
> index 3a070e7cdb8b..54b530db5ed0 100644
> --- a/arch/x86/power/cpu.c
> +++ b/arch/x86/power/cpu.c
> @@ -58,19 +58,20 @@ static void msr_restore_context(struct saved_context *ctxt)
> }
>
> /**
> - * __save_processor_state - save CPU registers before creating a
> - * hibernation image and before restoring the memory state from it
> - * @ctxt - structure to store the registers contents in
> + * __save_processor_statei() - Save CPU registers before creating a
> + * hibernation image and before restoring
> + * the memory state from it
> + * @ctxt: Structure to store the registers contents in.
> *
> - * NOTE: If there is a CPU register the modification of which by the
> - * boot kernel (ie. the kernel used for loading the hibernation image)
> - * might affect the operations of the restored target kernel (ie. the one
> - * saved in the hibernation image), then its contents must be saved by this
> - * function. In other words, if kernel A is hibernated and different
> - * kernel B is used for loading the hibernation image into memory, the
> - * kernel A's __save_processor_state() function must save all registers
> - * needed by kernel A, so that it can operate correctly after the resume
> - * regardless of what kernel B does in the meantime.
> + * NOTE: If there is a CPU register the modification of which by the
> + * boot kernel (ie. the kernel used for loading the hibernation image)
> + * might affect the operations of the restored target kernel (ie. the one
> + * saved in the hibernation image), then its contents must be saved by this
> + * function. In other words, if kernel A is hibernated and different
> + * kernel B is used for loading the hibernation image into memory, the
> + * kernel A's __save_processor_state() function must save all registers
> + * needed by kernel A, so that it can operate correctly after the resume
> + * regardless of what kernel B does in the meantime.
> */
> static void __save_processor_state(struct saved_context *ctxt)
> {
> @@ -181,9 +182,9 @@ static void fix_processor_context(void)
> }
>
> /**
> - * __restore_processor_state - restore the contents of CPU registers saved
> - * by __save_processor_state()
> - * @ctxt - structure to load the registers contents from
> + * __restore_processor_state() - Restore the contents of CPU registers saved
> + * by __save_processor_state()
> + * @ctxt: Structure to load the registers contents from.
> *
> * The asm code that gets us here will have restored a usable GDT, although
> * it will be pointing to the wrong alias.
> --
Applied as 5.14 material, thanks!
On Thu, Jun 17, 2021 at 2:12 PM Rafael J. Wysocki <[email protected]> wrote:
>
> On Tue, Jun 15, 2021 at 5:26 AM Baokun Li <[email protected]> wrote:
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> > arch/x86/power/cpu.c:76: warning: Function parameter or
> > member 'ctxt' not described in '__save_processor_state'
> > arch/x86/power/cpu.c:192: warning: Function parameter or
> > member 'ctxt' not described in '__restore_processor_state'
> >
> > Signed-off-by: Baokun Li <[email protected]>
> > ---
> > V1->V2:
> > Fix the formatting of this kerneldoc comment
> >
> > arch/x86/power/cpu.c | 31 ++++++++++++++++---------------
> > 1 file changed, 16 insertions(+), 15 deletions(-)
> >
> > diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
> > index 3a070e7cdb8b..54b530db5ed0 100644
> > --- a/arch/x86/power/cpu.c
> > +++ b/arch/x86/power/cpu.c
> > @@ -58,19 +58,20 @@ static void msr_restore_context(struct saved_context *ctxt)
> > }
> >
> > /**
> > - * __save_processor_state - save CPU registers before creating a
> > - * hibernation image and before restoring the memory state from it
> > - * @ctxt - structure to store the registers contents in
> > + * __save_processor_statei() - Save CPU registers before creating a
> > + * hibernation image and before restoring
> > + * the memory state from it
> > + * @ctxt: Structure to store the registers contents in.
> > *
> > - * NOTE: If there is a CPU register the modification of which by the
> > - * boot kernel (ie. the kernel used for loading the hibernation image)
> > - * might affect the operations of the restored target kernel (ie. the one
> > - * saved in the hibernation image), then its contents must be saved by this
> > - * function. In other words, if kernel A is hibernated and different
> > - * kernel B is used for loading the hibernation image into memory, the
> > - * kernel A's __save_processor_state() function must save all registers
> > - * needed by kernel A, so that it can operate correctly after the resume
> > - * regardless of what kernel B does in the meantime.
> > + * NOTE: If there is a CPU register the modification of which by the
> > + * boot kernel (ie. the kernel used for loading the hibernation image)
> > + * might affect the operations of the restored target kernel (ie. the one
> > + * saved in the hibernation image), then its contents must be saved by this
> > + * function. In other words, if kernel A is hibernated and different
> > + * kernel B is used for loading the hibernation image into memory, the
> > + * kernel A's __save_processor_state() function must save all registers
> > + * needed by kernel A, so that it can operate correctly after the resume
> > + * regardless of what kernel B does in the meantime.
> > */
> > static void __save_processor_state(struct saved_context *ctxt)
> > {
> > @@ -181,9 +182,9 @@ static void fix_processor_context(void)
> > }
> >
> > /**
> > - * __restore_processor_state - restore the contents of CPU registers saved
> > - * by __save_processor_state()
> > - * @ctxt - structure to load the registers contents from
> > + * __restore_processor_state() - Restore the contents of CPU registers saved
> > + * by __save_processor_state()
> > + * @ctxt: Structure to load the registers contents from.
> > *
> > * The asm code that gets us here will have restored a usable GDT, although
> > * it will be pointing to the wrong alias.
> > --
>
> Applied as 5.14 material, thanks!
And dropped, because it introduced a build issue.
Thank you for your advice.
I'm about to send a patch v3 with the changes to fix the warning.
Best Regards.
在 2021/6/18 1:32, Rafael J. Wysocki 写道:
> On Thu, Jun 17, 2021 at 2:12 PM Rafael J. Wysocki <[email protected]> wrote:
>> On Tue, Jun 15, 2021 at 5:26 AM Baokun Li <[email protected]> wrote:
>>> Fixes the following W=1 kernel build warning(s):
>>>
>>> arch/x86/power/cpu.c:76: warning: Function parameter or
>>> member 'ctxt' not described in '__save_processor_state'
>>> arch/x86/power/cpu.c:192: warning: Function parameter or
>>> member 'ctxt' not described in '__restore_processor_state'
>>>
>>> Signed-off-by: Baokun Li <[email protected]>
>>> ---
>>> V1->V2:
>>> Fix the formatting of this kerneldoc comment
>>>
>>> arch/x86/power/cpu.c | 31 ++++++++++++++++---------------
>>> 1 file changed, 16 insertions(+), 15 deletions(-)
>>>
>>> diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
>>> index 3a070e7cdb8b..54b530db5ed0 100644
>>> --- a/arch/x86/power/cpu.c
>>> +++ b/arch/x86/power/cpu.c
>>> @@ -58,19 +58,20 @@ static void msr_restore_context(struct saved_context *ctxt)
>>> }
>>>
>>> /**
>>> - * __save_processor_state - save CPU registers before creating a
>>> - * hibernation image and before restoring the memory state from it
>>> - * @ctxt - structure to store the registers contents in
>>> + * __save_processor_statei() - Save CPU registers before creating a
>>> + * hibernation image and before restoring
>>> + * the memory state from it
>>> + * @ctxt: Structure to store the registers contents in.
>>> *
>>> - * NOTE: If there is a CPU register the modification of which by the
>>> - * boot kernel (ie. the kernel used for loading the hibernation image)
>>> - * might affect the operations of the restored target kernel (ie. the one
>>> - * saved in the hibernation image), then its contents must be saved by this
>>> - * function. In other words, if kernel A is hibernated and different
>>> - * kernel B is used for loading the hibernation image into memory, the
>>> - * kernel A's __save_processor_state() function must save all registers
>>> - * needed by kernel A, so that it can operate correctly after the resume
>>> - * regardless of what kernel B does in the meantime.
>>> + * NOTE: If there is a CPU register the modification of which by the
>>> + * boot kernel (ie. the kernel used for loading the hibernation image)
>>> + * might affect the operations of the restored target kernel (ie. the one
>>> + * saved in the hibernation image), then its contents must be saved by this
>>> + * function. In other words, if kernel A is hibernated and different
>>> + * kernel B is used for loading the hibernation image into memory, the
>>> + * kernel A's __save_processor_state() function must save all registers
>>> + * needed by kernel A, so that it can operate correctly after the resume
>>> + * regardless of what kernel B does in the meantime.
>>> */
>>> static void __save_processor_state(struct saved_context *ctxt)
>>> {
>>> @@ -181,9 +182,9 @@ static void fix_processor_context(void)
>>> }
>>>
>>> /**
>>> - * __restore_processor_state - restore the contents of CPU registers saved
>>> - * by __save_processor_state()
>>> - * @ctxt - structure to load the registers contents from
>>> + * __restore_processor_state() - Restore the contents of CPU registers saved
>>> + * by __save_processor_state()
>>> + * @ctxt: Structure to load the registers contents from.
>>> *
>>> * The asm code that gets us here will have restored a usable GDT, although
>>> * it will be pointing to the wrong alias.
>>> --
>> Applied as 5.14 material, thanks!
> And dropped, because it introduced a build issue.
> .