Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f26621e6 authored by Borislav Petkov's avatar Borislav Petkov Committed by Ingo Molnar
Browse files

resource/docs: Complete kernel-doc style function documentation 



Add the missing kernel-doc style function parameters documentation.

Signed-off-by: default avatarBorislav Petkov <bp@suse.de>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: akpm@linux-foundation.org
Cc: linux-tip-commits@vger.kernel.org
Cc: rdunlap@infradead.org
Fixes: b69c2e20 ("resource: Clean it up a bit")
Link: http://lkml.kernel.org/r/20181105093307.GA12445@zn.tnic


Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
parent 81bd415c

kernel/resource.c

+14 −9
Original line number Diff line number Diff line
@@ -318,17 +318,24 @@ int release_resource(struct resource *old) 


EXPORT_SYMBOL(release_resource);



/*

 * Finds the lowest iomem resource that covers part of [start..end].  The

 * caller must specify start, end, flags, and desc (which may be

/**

 * Finds the lowest iomem resource that covers part of [@start..@end].  The

 * caller must specify @start, @end, @flags, and @desc (which may be

 * IORES_DESC_NONE).

 *

 * 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

 * -1. Returns -EINVAL for other invalid parameters.

 * 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

 * -1 or -EINVAL for other invalid parameters.

 *

 * This function walks the whole tree and not just first level children

 * unless @first_lvl is true.

 *

 * @start:	start address of the resource searched for

 * @end:	end address of same resource

 * @flags:	flags which the resource must have

 * @desc:	descriptor the resource must have

 * @first_lvl:	walk only the first level children, if set

 * @res:	return ptr, if resource found

 */

static int find_next_iomem_res(resource_size_t start, resource_size_t end,

			       unsigned long flags, unsigned long desc,
@@ -390,9 +397,7 @@ static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end, 
}



/**

 * walk_iomem_res_desc - walk through iomem resources

 *

 * Walks through iomem resources and calls @func() with matching resource

 * Walks through iomem resources and calls func() with matching resource

 * ranges. 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.