mirror of https://gitee.com/openkylin/linux.git
UBI: fix kernel-doc errors and warnings
No functional changes, just tweak comments to make kernel-doc work fine and stop complaining. Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy@nokia.com>
This commit is contained in:
Artem Bityutskiy
parent
9c9ec14770
commit
ebaaf1af3e
|
|
@ -159,8 +159,7 @@ void ubi_put_device(struct ubi_device *ubi)
|
|||
}
|
||||
|
||||
/**
|
||||
* ubi_get_by_major - get UBI device description object by character device
|
||||
* major number.
|
||||
* ubi_get_by_major - get UBI device by character device major number.
|
||||
* @major: major number
|
||||
*
|
||||
* This function is similar to 'ubi_get_device()', but it searches the device
|
||||
|
|
@ -727,7 +726,7 @@ static int autoresize(struct ubi_device *ubi, int vol_id)
|
|||
|
||||
/**
|
||||
* ubi_attach_mtd_dev - attach an MTD device.
|
||||
* @mtd_dev: MTD device description object
|
||||
* @mtd: MTD device description object
|
||||
* @ubi_num: number to assign to the new UBI device
|
||||
* @vid_hdr_offset: VID header offset
|
||||
*
|
||||
|
|
@ -1095,8 +1094,7 @@ static void __exit ubi_exit(void)
|
|||
module_exit(ubi_exit);
|
||||
|
||||
/**
|
||||
* bytes_str_to_int - convert a string representing number of bytes to an
|
||||
* integer.
|
||||
* bytes_str_to_int - convert a number of bytes string into an integer.
|
||||
* @str: the string to convert
|
||||
*
|
||||
* This function returns positive resulting integer in case of success and a
|
||||
|
|
|
|||
|
|
@ -1101,8 +1101,7 @@ static int paranoid_check_ec_hdr(const struct ubi_device *ubi, int pnum,
|
|||
}
|
||||
|
||||
/**
|
||||
* paranoid_check_peb_ec_hdr - check that the erase counter header of a
|
||||
* physical eraseblock is in-place and is all right.
|
||||
* paranoid_check_peb_ec_hdr - check erase counter header.
|
||||
* @ubi: UBI device description object
|
||||
* @pnum: the physical eraseblock number to check
|
||||
*
|
||||
|
|
@ -1180,8 +1179,7 @@ static int paranoid_check_vid_hdr(const struct ubi_device *ubi, int pnum,
|
|||
}
|
||||
|
||||
/**
|
||||
* paranoid_check_peb_vid_hdr - check that the volume identifier header of a
|
||||
* physical eraseblock is in-place and is all right.
|
||||
* paranoid_check_peb_vid_hdr - check volume identifier header.
|
||||
* @ubi: UBI device description object
|
||||
* @pnum: the physical eraseblock number to check
|
||||
*
|
||||
|
|
|
|||
|
|
@ -93,8 +93,7 @@ static int add_to_list(struct ubi_scan_info *si, int pnum, int ec,
|
|||
}
|
||||
|
||||
/**
|
||||
* validate_vid_hdr - check that volume identifier header is correct and
|
||||
* consistent.
|
||||
* validate_vid_hdr - check volume identifier header.
|
||||
* @vid_hdr: the volume identifier header to check
|
||||
* @sv: information about the volume this logical eraseblock belongs to
|
||||
* @pnum: physical eraseblock number the VID header came from
|
||||
|
|
@ -380,8 +379,7 @@ static int compare_lebs(struct ubi_device *ubi, const struct ubi_scan_leb *seb,
|
|||
}
|
||||
|
||||
/**
|
||||
* ubi_scan_add_used - add information about a physical eraseblock to the
|
||||
* scanning information.
|
||||
* ubi_scan_add_used - add physical eraseblock to the scanning information.
|
||||
* @ubi: UBI device description object
|
||||
* @si: scanning information
|
||||
* @pnum: the physical eraseblock number
|
||||
|
|
@ -555,8 +553,7 @@ int ubi_scan_add_used(struct ubi_device *ubi, struct ubi_scan_info *si,
|
|||
}
|
||||
|
||||
/**
|
||||
* ubi_scan_find_sv - find information about a particular volume in the
|
||||
* scanning information.
|
||||
* ubi_scan_find_sv - find volume in the scanning information.
|
||||
* @si: scanning information
|
||||
* @vol_id: the requested volume ID
|
||||
*
|
||||
|
|
@ -585,8 +582,7 @@ struct ubi_scan_volume *ubi_scan_find_sv(const struct ubi_scan_info *si,
|
|||
}
|
||||
|
||||
/**
|
||||
* ubi_scan_find_seb - find information about a particular logical
|
||||
* eraseblock in the volume scanning information.
|
||||
* ubi_scan_find_seb - find LEB in the volume scanning information.
|
||||
* @sv: a pointer to the volume scanning information
|
||||
* @lnum: the requested logical eraseblock
|
||||
*
|
||||
|
|
@ -744,8 +740,7 @@ struct ubi_scan_leb *ubi_scan_get_free_peb(struct ubi_device *ubi,
|
|||
}
|
||||
|
||||
/**
|
||||
* process_eb - read UBI headers, check them and add corresponding data
|
||||
* to the scanning information.
|
||||
* process_eb - read, check UBI headers, and add them to scanning information.
|
||||
* @ubi: UBI device description object
|
||||
* @si: scanning information
|
||||
* @pnum: the physical eraseblock number
|
||||
|
|
@ -1083,8 +1078,7 @@ void ubi_scan_destroy_si(struct ubi_scan_info *si)
|
|||
#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
|
||||
|
||||
/**
|
||||
* paranoid_check_si - check if the scanning information is correct and
|
||||
* consistent.
|
||||
* paranoid_check_si - check the scanning information.
|
||||
* @ubi: UBI device description object
|
||||
* @si: scanning information
|
||||
*
|
||||
|
|
|
|||
|
|
@ -313,6 +313,7 @@ struct ubi_wl_entry;
|
|||
* @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works
|
||||
* fields
|
||||
* @move_mutex: serializes eraseblock moves
|
||||
* @work_sem: sycnhronizes the WL worker with use tasks
|
||||
* @wl_scheduled: non-zero if the wear-leveling was scheduled
|
||||
* @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
|
||||
* physical eraseblock
|
||||
|
|
|
|||
|
|
@ -268,6 +268,7 @@ static int write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
|
|||
|
||||
/**
|
||||
* ubi_more_update_data - write more update data.
|
||||
* @ubi: UBI device description object
|
||||
* @vol: volume description object
|
||||
* @buf: write data (user-space memory buffer)
|
||||
* @count: how much bytes to write
|
||||
|
|
@ -385,6 +386,7 @@ int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
|
|||
|
||||
/**
|
||||
* ubi_more_leb_change_data - accept more data for atomic LEB change.
|
||||
* @ubi: UBI device description object
|
||||
* @vol: volume description object
|
||||
* @buf: write data (user-space memory buffer)
|
||||
* @count: how much bytes to write
|
||||
|
|
|
|||
|
|
@ -608,7 +608,7 @@ int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs)
|
|||
/**
|
||||
* ubi_rename_volumes - re-name UBI volumes.
|
||||
* @ubi: UBI device description object
|
||||
* @renam_list: list of &struct ubi_rename_entry objects
|
||||
* @rename_list: list of &struct ubi_rename_entry objects
|
||||
*
|
||||
* This function re-names or removes volumes specified in the re-name list.
|
||||
* Returns zero in case of success and a negative error code in case of
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
|
|||
/**
|
||||
* ubi_vtbl_rename_volumes - rename UBI volumes in the volume table.
|
||||
* @ubi: UBI device description object
|
||||
* @renam_list: list of &struct ubi_rename_entry objects
|
||||
* @rename_list: list of &struct ubi_rename_entry objects
|
||||
*
|
||||
* This function re-names multiple volumes specified in @req in the volume
|
||||
* table. Returns zero in case of success and a negative error code in case of
|
||||
|
|
@ -166,8 +166,7 @@ int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
|
|||
}
|
||||
|
||||
/**
|
||||
* vtbl_check - check if volume table is not corrupted and contains sensible
|
||||
* data.
|
||||
* vtbl_check - check if volume table is not corrupted and sensible.
|
||||
* @ubi: UBI device description object
|
||||
* @vtbl: volume table
|
||||
*
|
||||
|
|
@ -780,8 +779,7 @@ static int check_scanning_info(const struct ubi_device *ubi,
|
|||
}
|
||||
|
||||
/**
|
||||
* ubi_read_volume_table - read volume table.
|
||||
* information.
|
||||
* ubi_read_volume_table - read the volume table.
|
||||
* @ubi: UBI device description object
|
||||
* @si: scanning information
|
||||
*
|
||||
|
|
|
|||
|
|
@ -632,8 +632,7 @@ static int sync_erase(struct ubi_device *ubi, struct ubi_wl_entry *e,
|
|||
}
|
||||
|
||||
/**
|
||||
* check_protection_over - check if it is time to stop protecting some
|
||||
* physical eraseblocks.
|
||||
* check_protection_over - check if it is time to stop protecting some PEBs.
|
||||
* @ubi: UBI device description object
|
||||
*
|
||||
* This function is called after each erase operation, when the absolute erase
|
||||
|
|
@ -1601,8 +1600,7 @@ void ubi_wl_close(struct ubi_device *ubi)
|
|||
#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
|
||||
|
||||
/**
|
||||
* paranoid_check_ec - make sure that the erase counter of a physical eraseblock
|
||||
* is correct.
|
||||
* paranoid_check_ec - make sure that the erase counter of a PEB is correct.
|
||||
* @ubi: UBI device description object
|
||||
* @pnum: the physical eraseblock number to check
|
||||
* @ec: the erase counter to check
|
||||
|
|
@ -1643,13 +1641,12 @@ static int paranoid_check_ec(struct ubi_device *ubi, int pnum, int ec)
|
|||
}
|
||||
|
||||
/**
|
||||
* paranoid_check_in_wl_tree - make sure that a wear-leveling entry is present
|
||||
* in a WL RB-tree.
|
||||
* paranoid_check_in_wl_tree - check that wear-leveling entry is in WL RB-tree.
|
||||
* @e: the wear-leveling entry to check
|
||||
* @root: the root of the tree
|
||||
*
|
||||
* This function returns zero if @e is in the @root RB-tree and %1 if it
|
||||
* is not.
|
||||
* This function returns zero if @e is in the @root RB-tree and %1 if it is
|
||||
* not.
|
||||
*/
|
||||
static int paranoid_check_in_wl_tree(struct ubi_wl_entry *e,
|
||||
struct rb_root *root)
|
||||
|
|
|
|||
Loading…
Reference in New Issue