Commit 3be8da57 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Linus Torvalds

kernel/resource.c: fix kernel-doc markups

Kernel-doc markups should use this format:
        identifier - description

While here, fix a kernel-doc tag that was using, instead,
a normal comment block.

[akpm@linux-foundation.org: coding style fixes]

Link: https://lkml.kernel.org/r/c5e38e1070f8dbe2f9607a10b44afe2875bd966c.1605521731.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Jonathan Corbet" <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent abf4e00c
...@@ -320,9 +320,8 @@ int release_resource(struct resource *old) ...@@ -320,9 +320,8 @@ int release_resource(struct resource *old)
EXPORT_SYMBOL(release_resource); EXPORT_SYMBOL(release_resource);
/** /**
* Finds the lowest iomem resource that covers part of [@start..@end]. The * find_next_iomem_res - Finds the lowest iomem resource that covers part of
* caller must specify @start, @end, @flags, and @desc (which may be * [@start..@end].
* IORES_DESC_NONE).
* *
* If a resource is found, returns 0 and @*res is overwritten with the part * If a resource is found, returns 0 and @*res is overwritten with the part
* of the resource that's within [@start..@end]; if none is found, returns * of the resource that's within [@start..@end]; if none is found, returns
...@@ -337,6 +336,9 @@ EXPORT_SYMBOL(release_resource); ...@@ -337,6 +336,9 @@ EXPORT_SYMBOL(release_resource);
* @desc: descriptor the resource must have * @desc: descriptor the resource must have
* @first_lvl: walk only the first level children, if set * @first_lvl: walk only the first level children, if set
* @res: return ptr, if resource found * @res: return ptr, if resource found
*
* The caller must specify @start, @end, @flags, and @desc
* (which may be IORES_DESC_NONE).
*/ */
static int find_next_iomem_res(resource_size_t start, resource_size_t end, static int find_next_iomem_res(resource_size_t start, resource_size_t end,
unsigned long flags, unsigned long desc, unsigned long flags, unsigned long desc,
...@@ -416,11 +418,9 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end, ...@@ -416,11 +418,9 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end,
} }
/** /**
* Walks through iomem resources and calls func() with matching resource * walk_iomem_res_desc - Walks through iomem resources and calls func()
* ranges. This walks through whole tree and not just first level children. * with matching resource ranges.
* All the memory ranges which overlap start,end and also match flags and * *
* desc are valid candidates.
*
* @desc: I/O resource descriptor. Use IORES_DESC_NONE to skip @desc check. * @desc: I/O resource descriptor. Use IORES_DESC_NONE to skip @desc check.
* @flags: I/O resource flags * @flags: I/O resource flags
* @start: start addr * @start: start addr
...@@ -428,6 +428,10 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end, ...@@ -428,6 +428,10 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end,
* @arg: function argument for the callback @func * @arg: function argument for the callback @func
* @func: callback function that is called for each qualifying resource area * @func: callback function that is called for each qualifying resource area
* *
* This walks through whole tree and not just first level children.
* All the memory ranges which overlap start,end and also match flags and
* desc are valid candidates.
*
* NOTE: For a new descriptor search, define a new IORES_DESC in * NOTE: For a new descriptor search, define a new IORES_DESC in
* <linux/ioport.h> and set it in 'desc' of a target resource entry. * <linux/ioport.h> and set it in 'desc' of a target resource entry.
*/ */
...@@ -1372,9 +1376,9 @@ static bool system_ram_resources_mergeable(struct resource *r1, ...@@ -1372,9 +1376,9 @@ static bool system_ram_resources_mergeable(struct resource *r1,
!r1->child && !r2->child; !r1->child && !r2->child;
} }
/* /**
* merge_system_ram_resource - mark the System RAM resource mergeable and try to * merge_system_ram_resource - mark the System RAM resource mergeable and try to
* merge it with adjacent, mergeable resources * merge it with adjacent, mergeable resources
* @res: resource descriptor * @res: resource descriptor
* *
* This interface is intended for memory hotplug, whereby lots of contiguous * This interface is intended for memory hotplug, whereby lots of contiguous
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment