ACPI: NVS: fix doc warnings in nvs.c

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>
This commit is contained in:
Baokun Li 2021-06-15 15:43:17 +08:00 committed by Rafael J. Wysocki
parent 237a47ebc3
commit 120f4aa80b
1 changed files with 12 additions and 12 deletions

View File

@ -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)
{
@ -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)
{
@ -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)
{
@ -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)
{
@ -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)
{