kernel/power/snapshot: Add missing kernel-doc parameter descriptions
Subsystems (2)
PATCH 1/1 kernel/power/snapshot: Add missing kernel-doc parameter descriptions
Add missing parameter descriptions in kernel-doc comments to fix warnings reported by scripts/kernel-doc -none.
Signed-off-by Ronan Marchal <[email protected]>
--- kernel/power/snapshot.c | 62 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 4 deletions(-)
kernel/power/snapshot.c +58 -4
@@ -460,6 +460,11 @@ static struct rtree_node *alloc_rtree_node(gfp_t gfp_mask, int safe_needed,/** * add_rtree_block - Add a new leave node to the radix tree. +* @gfp_mask: GFP mask for the allocation. +* @safe_needed: Get pages not used before hibernation (restore only) +* @ca: Pointer to a linked list of pages ("a chain") to allocate from +* @zone: The radix tree zone bitmap whose blocks counter tracks +* the position of the next leave node to allocate. * * The leave nodes need to be allocated in order to keep the leaves * linked list in order. This is guaranteed by the zone->blocks
@@ -530,10 +535,15 @@ static void free_zone_bm_rtree(struct mem_zone_bm_rtree *zone,/** * create_zone_bm_rtree - Create a radix tree for one zone. +* @gfp_mask: GFP mask for the allocation. +* @safe_needed: Get pages not used before hibernation (restore only). +* @ca: Pointer to a linked list of pages ("a chain") to allocate from. +* @start: Start PFN of the zone. +* @end: End PFN of the zone. * -* Allocated the mem_zone_bm_rtree structure and initializes it. -* This function also allocated and builds the radix tree for the -* zone. +* Allocates and initializes the mem_zone_bm_rtree structure, including +* its nodes and leaves lists. Builds the radix tree by allocating the +* number of blocks required to cover all pages in the [@start, @end] range. */ static struct mem_zone_bm_rtree *create_zone_bm_rtree(gfp_t gfp_mask, int safe_needed,
@@ -568,6 +578,8 @@ static struct mem_zone_bm_rtree *create_zone_bm_rtree(gfp_t gfp_mask,/** * free_zone_bm_rtree - Free the memory of the radix tree. +* @zone: The radix tree to free. +* @clear_nosave_free: If set, clear the PageNosaveFree bit for the page. * * Free all node pages of the radix tree. The mem_zone_bm_rtree * structure itself is not freed here nor are the rtree_node
@@ -680,6 +692,11 @@ static int create_mem_extents(struct list_head *list, gfp_t gfp_mask)/** * memory_bm_create - Allocate memory for a memory bitmap. +* @bm: Memory bitmap. +* @gfp_mask: GFP mask for the allocation. +* @safe_needed: Get pages not used before hibernation (restore only). +* +* Allocate memory for a memory bitmap and initialize it. */ static int memory_bm_create (struct memory_bitmap *bm,gfp_t gfp_mask,int safe_needed)
@@ -723,6 +740,8 @@ static int memory_bm_create(struct memory_bitmap *bm, gfp_t gfp_mask,/** * memory_bm_free - Free memory occupied by the memory bitmap. * @bm: Memory bitmap. +* @clear_nosave_free: If set, clear the PageNosaveFree bit for the page. +* */ static void memory_bm_free (struct memory_bitmap *bm,int clear_nosave_free) {
@@ -738,6 +757,10 @@ static void memory_bm_free(struct memory_bitmap *bm, int clear_nosave_free)/** * memory_bm_find_bit - Find the bit for a given PFN in a memory bitmap. +* @bm: Memory bitmap. +* @pfn: The page frame number to find. +* @addr: The address of the memory page containing the bit for @pfn. +* @bit_nr: The bit index within the page for @pfn. * * Find the bit in memory bitmap @bm that corresponds to the given PFN. * The cur.zone, cur.block and cur.node_pfn members of @bm are updated.
@@ -881,6 +904,7 @@ static bool memory_bm_pfn_present(struct memory_bitmap *bm, unsigned long pfn)/* * rtree_next_node - Jump to the next leaf node. +* @bm: Memory bitmap. * * Set the position to the beginning of the next node in the * memory bitmap. This is either the next node in the current
@@ -990,6 +1014,8 @@ static void memory_bm_recycle(struct memory_bitmap *bm)/** * register_nosave_region - Register a region of unsaveable memory. +* @start_pfn: The starting page frame number. +* @end_pfn: The ending page frame number. * * Register a range of page frames the contents of which should not be saved * during hibernation (to be used in the early initialization code).
@@ -1307,6 +1333,8 @@ static unsigned int count_free_highmem_pages(void)/** * saveable_highmem_page - Check if a highmem page is saveable. +* @zone: The zone to which the page belongs. +* @pfn: The page frame number of the page to check. * * Determine whether a highmem page should be included in a hibernation image. *
@@ -1364,6 +1392,8 @@ static unsigned int count_highmem_pages(void)/** * saveable_page - Check if the given page is saveable. +* @zone: The zone to which the page belongs. +* @pfn: The page frame number of the page to check. * * Determine whether a non-highmem page should be included in a hibernation * image.
@@ -1442,6 +1472,8 @@ static inline bool do_copy_page(long *dst, long *src)/** * safe_copy_page - Copy a page in a safe way. +* @dst: The destination address to copy to. +* @s_page: The source page to copy from. * * Check if the page we are going to copy is marked as present in the kernel * page tables. This always is the case if CONFIG_DEBUG_PAGEALLOC or
@@ -1688,7 +1720,10 @@ static unsigned long preallocate_image_highmem(unsigned long nr_pages) }/** -* __fraction - Compute (an approximation of) x * (multiplier / base). +* __fraction - Compute (an approximation of) x * (multiplier / base). +* @x: The value to multiply. +* @multiplier: The numerator of the fraction. +* @base: The denominator of the fraction. */ static unsigned long __fraction (u64 x,u64 multiplier,u64 base) {
@@ -1984,6 +2019,7 @@ int hibernate_preallocate_memory(void)#ifdef CONFIG_HIGHMEM /** * count_pages_for_highmem - Count non-highmem pages needed for copying highmem. +* @nr_highmem: Number of highmem pages to copy. * * Compute the number of non-highmem pages that will be necessary for creating * copies of highmem pages.
@@ -2005,6 +2041,11 @@ static unsigned int count_pages_for_highmem(unsigned int nr_highmem) { return 0;/** * enough_free_mem - Check if there is enough free memory for the image. +* @nr_pages: Number of non-highmem pages to copy. +* @nr_highmem: Number of highmem pages to copy. +* +* Check if there are enough free non-highmem pages available to save +* the hibernation image. */ static int enough_free_mem (unsigned int nr_pages,unsigned int nr_highmem) {
@@ -2025,6 +2066,7 @@ static int enough_free_mem(unsigned int nr_pages, unsigned int nr_highmem)#ifdef CONFIG_HIGHMEM /** * get_highmem_buffer - Allocate a buffer for highmem pages. +* @safe_needed: The type of pages to allocate for the buffer. * * If there are some highmem pages in the hibernation image, we may need a * buffer to copy them and/or load their data.
@@ -2037,6 +2079,8 @@ static inline int get_highmem_buffer(int safe_needed)/** * alloc_highmem_pages - Allocate some highmem pages for the image. +* @bm: Memory bitmap. +* @nr_highmem: Number of highmem pages to allocate. * * Try to allocate as many pages as needed, but if the number of free highmem * pages is less than that, allocate them all.
@@ -2067,6 +2111,9 @@ static inline unsigned int alloc_highmem_pages(struct memory_bitmap *bm,/** * swsusp_alloc - Allocate memory for hibernation image. +* @copy_bm: Memory bitmap. +* @nr_pages: Number of non-highmem pages to allocate. +* @nr_highmem: Number of highmem pages to allocate. * * We first try to allocate as many highmem pages as there are * saveable highmem pages in the system. If that fails, we allocate
@@ -2294,6 +2341,7 @@ static void duplicate_memory_bitmap(struct memory_bitmap *dst,/** * mark_unsafe_pages - Mark pages that were used before hibernation. +* @bm: Memory bitmap. * * Mark the pages that cannot be used for storing the image during restoration, * because they conflict with the pages that had been used before hibernation.
@@ -2332,6 +2380,7 @@ static int check_header(struct swsusp_info *info)/** * load_header - Check the image header and copy the data from it. +* @info: Structure containing the image header. */ static int load_header (struct swsusp_info *info) {
@@ -2485,6 +2534,8 @@ static struct page *last_highmem_page;/** * get_highmem_page_buffer - Prepare a buffer to store a highmem image page. +* @page: Pointer to the highmem image page. +* @ca: Pointer to the chain allocator structure. * * For a given highmem image page get a buffer that suspend_write_next() should * return to its caller to write to.
@@ -2708,6 +2759,8 @@ static int prepare_image(struct memory_bitmap *new_bm, struct memory_bitmap *bm,/** * get_buffer - Get the address to store the next image data page. +* @bm: Memory bitmap. +* @ca: Pointer to the chain allocator structure. * * Get the address that snapshot_write_next() should return to its caller to * write to.
@@ -2845,6 +2898,7 @@ int snapshot_write_next(struct snapshot_handle *handle)/** * snapshot_write_finalize - Complete the loading of a hibernation image. +* @handle: Snapshot handle structure to guide the writing. * * Must be called after the last call to snapshot_write_next() in case the last * page in the image happens to be a highmem page and its contents should be
Signature · 1 line
2.53.0