openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs/mm: nobootmem: fixup kernel-doc comments 

* add kernel-doc marking to free_bootmem_late() description
* add return value descriptions
* mention that address parameter of free_bootmem{_node} is a physical address

Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mike Rapoport 2018-06-30 17:54:57 +03:00 committed by Jonathan Corbet
parent 04c450603f
commit 8108ad51fe
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
mm/nobootmem.c
View File

@ -72,7 +72,7 @@ static void * __init __alloc_memory_core_early(int nid, u64 size, u64 align,
return ptr; return ptr;
} }
/* /**
* free_bootmem_late - free bootmem pages directly to page allocator * free_bootmem_late - free bootmem pages directly to page allocator
* @addr: starting address of the range * @addr: starting address of the range
* @size: size of the range in bytes * @size: size of the range in bytes
@ -176,7 +176,7 @@ void __init reset_all_zones_managed_pages(void)
/** /**
* free_all_bootmem - release free pages to the buddy allocator * free_all_bootmem - release free pages to the buddy allocator
* *
* Returns the number of pages actually released. * Return: the number of pages actually released.
*/ */
unsigned long __init free_all_bootmem(void) unsigned long __init free_all_bootmem(void)
{ {
@ -193,7 +193,7 @@ unsigned long __init free_all_bootmem(void)
/** /**
* free_bootmem_node - mark a page range as usable * free_bootmem_node - mark a page range as usable
* @pgdat: node the range resides on * @pgdat: node the range resides on
* @physaddr: starting address of the range * @physaddr: starting physical address of the range
* @size: size of the range in bytes * @size: size of the range in bytes
* *
* Partial pages will be considered reserved and left as they are. * Partial pages will be considered reserved and left as they are.
@ -208,7 +208,7 @@ void __init free_bootmem_node(pg_data_t *pgdat, unsigned long physaddr,
/** /**
* free_bootmem - mark a page range as usable * free_bootmem - mark a page range as usable
* @addr: starting address of the range * @addr: starting physical address of the range
* @size: size of the range in bytes * @size: size of the range in bytes
* *
* Partial pages will be considered reserved and left as they are. * Partial pages will be considered reserved and left as they are.
@ -256,7 +256,7 @@ static void * __init ___alloc_bootmem_nopanic(unsigned long size,
* *
* Allocation may happen on any node in the system. * Allocation may happen on any node in the system.
* *
* Returns NULL on failure. * Return: address of the allocated region or %NULL on failure.
*/ */
void * __init __alloc_bootmem_nopanic(unsigned long size, unsigned long align, void * __init __alloc_bootmem_nopanic(unsigned long size, unsigned long align,
unsigned long goal) unsigned long goal)
@ -293,6 +293,8 @@ static void * __init ___alloc_bootmem(unsigned long size, unsigned long align,
* Allocation may happen on any node in the system. * Allocation may happen on any node in the system.
* *
* The function panics if the request can not be satisfied. * The function panics if the request can not be satisfied.
*
* Return: address of the allocated region.
*/ */
void * __init __alloc_bootmem(unsigned long size, unsigned long align, void * __init __alloc_bootmem(unsigned long size, unsigned long align,
unsigned long goal) unsigned long goal)
@ -367,6 +369,8 @@ static void * __init ___alloc_bootmem_node(pg_data_t *pgdat, unsigned long size,
* can not hold the requested memory. * can not hold the requested memory.
* *
* The function panics if the request can not be satisfied. * The function panics if the request can not be satisfied.
*
* Return: address of the allocated region.
*/ */
void * __init __alloc_bootmem_node(pg_data_t *pgdat, unsigned long size, void * __init __alloc_bootmem_node(pg_data_t *pgdat, unsigned long size,
unsigned long align, unsigned long goal) unsigned long align, unsigned long goal)
@ -396,6 +400,8 @@ void * __init __alloc_bootmem_node_high(pg_data_t *pgdat, unsigned long size,
* Allocation may happen on any node in the system. * Allocation may happen on any node in the system.
* *
* The function panics if the request can not be satisfied. * The function panics if the request can not be satisfied.
*
* Return: address of the allocated region.
*/ */
void * __init __alloc_bootmem_low(unsigned long size, unsigned long align, void * __init __alloc_bootmem_low(unsigned long size, unsigned long align,
unsigned long goal) unsigned long goal)
@ -425,6 +431,8 @@ void * __init __alloc_bootmem_low_nopanic(unsigned long size,
* can not hold the requested memory. * can not hold the requested memory.
* *
* The function panics if the request can not be satisfied. * The function panics if the request can not be satisfied.
*
* Return: address of the allocated region.
*/ */
void * __init __alloc_bootmem_low_node(pg_data_t *pgdat, unsigned long size, void * __init __alloc_bootmem_low_node(pg_data_t *pgdat, unsigned long size,
unsigned long align, unsigned long goal) unsigned long align, unsigned long goal)