Skip to content

Commit

Permalink
ACPI: NVS: fix doc warnings in nvs.c
Browse files Browse the repository at this point in the history
Fixes the following W=1 kernel build warning(s):

 drivers/acpi/nvs.c:94: warning: Function parameter or
  member 'start' not described in 'suspend_nvs_register'
 drivers/acpi/nvs.c:94: warning: Function parameter or
  member 'size' not described in 'suspend_nvs_register'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
[ rjw: Subject edits ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  • Loading branch information
Baokun Li authored and Rafael J. Wysocki committed Jun 17, 2021
1 parent 237a47e commit 120f4aa
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions drivers/acpi/nvs.c
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,13 @@ struct nvs_page {
static LIST_HEAD(nvs_list);

/**
* suspend_nvs_register - register platform NVS memory region to save
* @start - physical address of the region
* @size - size of the region
* suspend_nvs_register - register platform NVS memory region to save
* @start: Physical address of the region.
* @size: Size of the region.
*
* The NVS region need not be page-aligned (both ends) and we arrange
* things so that the data from page-aligned addresses in this region will
* be copied into separate RAM pages.
* The NVS region need not be page-aligned (both ends) and we arrange
* things so that the data from page-aligned addresses in this region will
* be copied into separate RAM pages.
*/
static int suspend_nvs_register(unsigned long start, unsigned long size)
{
Expand Down Expand Up @@ -123,7 +123,7 @@ static int suspend_nvs_register(unsigned long start, unsigned long size)
}

/**
* suspend_nvs_free - free data pages allocated for saving NVS regions
* suspend_nvs_free - free data pages allocated for saving NVS regions
*/
void suspend_nvs_free(void)
{
Expand All @@ -147,7 +147,7 @@ void suspend_nvs_free(void)
}

/**
* suspend_nvs_alloc - allocate memory necessary for saving NVS regions
* suspend_nvs_alloc - allocate memory necessary for saving NVS regions
*/
int suspend_nvs_alloc(void)
{
Expand All @@ -164,7 +164,7 @@ int suspend_nvs_alloc(void)
}

/**
* suspend_nvs_save - save NVS memory regions
* suspend_nvs_save - save NVS memory regions
*/
int suspend_nvs_save(void)
{
Expand Down Expand Up @@ -193,10 +193,10 @@ int suspend_nvs_save(void)
}

/**
* suspend_nvs_restore - restore NVS memory regions
* suspend_nvs_restore - restore NVS memory regions
*
* This function is going to be called with interrupts disabled, so it
* cannot iounmap the virtual addresses used to access the NVS region.
* This function is going to be called with interrupts disabled, so it
* cannot iounmap the virtual addresses used to access the NVS region.
*/
void suspend_nvs_restore(void)
{
Expand Down

0 comments on commit 120f4aa

Please sign in to comment.