aboutsummaryrefslogtreecommitdiffstats
path: root/drivers
diff options
context:
space:
mode:
authorArtem Bityutskiy <Artem.Bityutskiy@nokia.com>2008-07-18 06:34:32 -0400
committerArtem Bityutskiy <Artem.Bityutskiy@nokia.com>2008-07-24 06:36:09 -0400
commitebaaf1af3e9ef05c4fb7c61e4530c15e1ad10e3b (patch)
tree3ecf6d4439ca27b4a3f7ae7c105eb94f3b16f978 /drivers
parent9c9ec147709e63e4e8ac6a037c6bb50688ff8e9c (diff)
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>
Diffstat (limited to 'drivers')
-rw-r--r--drivers/mtd/ubi/build.c8
-rw-r--r--drivers/mtd/ubi/io.c6
-rw-r--r--drivers/mtd/ubi/scan.c18
-rw-r--r--drivers/mtd/ubi/ubi.h1
-rw-r--r--drivers/mtd/ubi/upd.c2
-rw-r--r--drivers/mtd/ubi/vmt.c2
-rw-r--r--drivers/mtd/ubi/vtbl.c8
-rw-r--r--drivers/mtd/ubi/wl.c13
8 files changed, 23 insertions, 35 deletions
diff --git a/drivers/mtd/ubi/build.c b/drivers/mtd/ubi/build.c
index 535d9a8a6ba8..eba760b3b8c7 100644
--- a/drivers/mtd/ubi/build.c
+++ b/drivers/mtd/ubi/build.c
@@ -159,8 +159,7 @@ void ubi_put_device(struct ubi_device *ubi)
159} 159}
160 160
161/** 161/**
162 * ubi_get_by_major - get UBI device description object by character device 162 * ubi_get_by_major - get UBI device by character device major number.
163 * major number.
164 * @major: major number 163 * @major: major number
165 * 164 *
166 * This function is similar to 'ubi_get_device()', but it searches the device 165 * 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)
727 726
728/** 727/**
729 * ubi_attach_mtd_dev - attach an MTD device. 728 * ubi_attach_mtd_dev - attach an MTD device.
730 * @mtd_dev: MTD device description object 729 * @mtd: MTD device description object
731 * @ubi_num: number to assign to the new UBI device 730 * @ubi_num: number to assign to the new UBI device
732 * @vid_hdr_offset: VID header offset 731 * @vid_hdr_offset: VID header offset
733 * 732 *
@@ -1095,8 +1094,7 @@ static void __exit ubi_exit(void)
1095module_exit(ubi_exit); 1094module_exit(ubi_exit);
1096 1095
1097/** 1096/**
1098 * bytes_str_to_int - convert a string representing number of bytes to an 1097 * bytes_str_to_int - convert a number of bytes string into an integer.
1099 * integer.
1100 * @str: the string to convert 1098 * @str: the string to convert
1101 * 1099 *
1102 * This function returns positive resulting integer in case of success and a 1100 * This function returns positive resulting integer in case of success and a
diff --git a/drivers/mtd/ubi/io.c b/drivers/mtd/ubi/io.c
index a84f0db0a03a..2fb64be44f1b 100644
--- a/drivers/mtd/ubi/io.c
+++ b/drivers/mtd/ubi/io.c
@@ -1101,8 +1101,7 @@ fail:
1101} 1101}
1102 1102
1103/** 1103/**
1104 * paranoid_check_peb_ec_hdr - check that the erase counter header of a 1104 * paranoid_check_peb_ec_hdr - check erase counter header.
1105 * physical eraseblock is in-place and is all right.
1106 * @ubi: UBI device description object 1105 * @ubi: UBI device description object
1107 * @pnum: the physical eraseblock number to check 1106 * @pnum: the physical eraseblock number to check
1108 * 1107 *
@@ -1180,8 +1179,7 @@ fail:
1180} 1179}
1181 1180
1182/** 1181/**
1183 * paranoid_check_peb_vid_hdr - check that the volume identifier header of a 1182 * paranoid_check_peb_vid_hdr - check volume identifier header.
1184 * physical eraseblock is in-place and is all right.
1185 * @ubi: UBI device description object 1183 * @ubi: UBI device description object
1186 * @pnum: the physical eraseblock number to check 1184 * @pnum: the physical eraseblock number to check
1187 * 1185 *
diff --git a/drivers/mtd/ubi/scan.c b/drivers/mtd/ubi/scan.c
index 0bb7488862d2..4dfbf27b0656 100644
--- a/drivers/mtd/ubi/scan.c
+++ b/drivers/mtd/ubi/scan.c
@@ -93,8 +93,7 @@ static int add_to_list(struct ubi_scan_info *si, int pnum, int ec,
93} 93}
94 94
95/** 95/**
96 * validate_vid_hdr - check that volume identifier header is correct and 96 * validate_vid_hdr - check volume identifier header.
97 * consistent.
98 * @vid_hdr: the volume identifier header to check 97 * @vid_hdr: the volume identifier header to check
99 * @sv: information about the volume this logical eraseblock belongs to 98 * @sv: information about the volume this logical eraseblock belongs to
100 * @pnum: physical eraseblock number the VID header came from 99 * @pnum: physical eraseblock number the VID header came from
@@ -380,8 +379,7 @@ out_free_vidh:
380} 379}
381 380
382/** 381/**
383 * ubi_scan_add_used - add information about a physical eraseblock to the 382 * ubi_scan_add_used - add physical eraseblock to the scanning information.
384 * scanning information.
385 * @ubi: UBI device description object 383 * @ubi: UBI device description object
386 * @si: scanning information 384 * @si: scanning information
387 * @pnum: the physical eraseblock number 385 * @pnum: the physical eraseblock number
@@ -555,8 +553,7 @@ int ubi_scan_add_used(struct ubi_device *ubi, struct ubi_scan_info *si,
555} 553}
556 554
557/** 555/**
558 * ubi_scan_find_sv - find information about a particular volume in the 556 * ubi_scan_find_sv - find volume in the scanning information.
559 * scanning information.
560 * @si: scanning information 557 * @si: scanning information
561 * @vol_id: the requested volume ID 558 * @vol_id: the requested volume ID
562 * 559 *
@@ -585,8 +582,7 @@ struct ubi_scan_volume *ubi_scan_find_sv(const struct ubi_scan_info *si,
585} 582}
586 583
587/** 584/**
588 * ubi_scan_find_seb - find information about a particular logical 585 * ubi_scan_find_seb - find LEB in the volume scanning information.
589 * eraseblock in the volume scanning information.
590 * @sv: a pointer to the volume scanning information 586 * @sv: a pointer to the volume scanning information
591 * @lnum: the requested logical eraseblock 587 * @lnum: the requested logical eraseblock
592 * 588 *
@@ -744,8 +740,7 @@ struct ubi_scan_leb *ubi_scan_get_free_peb(struct ubi_device *ubi,
744} 740}
745 741
746/** 742/**
747 * process_eb - read UBI headers, check them and add corresponding data 743 * process_eb - read, check UBI headers, and add them to scanning information.
748 * to the scanning information.
749 * @ubi: UBI device description object 744 * @ubi: UBI device description object
750 * @si: scanning information 745 * @si: scanning information
751 * @pnum: the physical eraseblock number 746 * @pnum: the physical eraseblock number
@@ -1083,8 +1078,7 @@ void ubi_scan_destroy_si(struct ubi_scan_info *si)
1083#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID 1078#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1084 1079
1085/** 1080/**
1086 * paranoid_check_si - check if the scanning information is correct and 1081 * paranoid_check_si - check the scanning information.
1087 * consistent.
1088 * @ubi: UBI device description object 1082 * @ubi: UBI device description object
1089 * @si: scanning information 1083 * @si: scanning information
1090 * 1084 *
diff --git a/drivers/mtd/ubi/ubi.h b/drivers/mtd/ubi/ubi.h
index 14a5596d2d9e..1c3fa18c26a7 100644
--- a/drivers/mtd/ubi/ubi.h
+++ b/drivers/mtd/ubi/ubi.h
@@ -313,6 +313,7 @@ struct ubi_wl_entry;
313 * @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works 313 * @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works
314 * fields 314 * fields
315 * @move_mutex: serializes eraseblock moves 315 * @move_mutex: serializes eraseblock moves
316 * @work_sem: sycnhronizes the WL worker with use tasks
316 * @wl_scheduled: non-zero if the wear-leveling was scheduled 317 * @wl_scheduled: non-zero if the wear-leveling was scheduled
317 * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any 318 * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
318 * physical eraseblock 319 * physical eraseblock
diff --git a/drivers/mtd/ubi/upd.c b/drivers/mtd/ubi/upd.c
index 3b8beb8545c4..8b89cc18ff0b 100644
--- a/drivers/mtd/ubi/upd.c
+++ b/drivers/mtd/ubi/upd.c
@@ -268,6 +268,7 @@ static int write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
268 268
269/** 269/**
270 * ubi_more_update_data - write more update data. 270 * ubi_more_update_data - write more update data.
271 * @ubi: UBI device description object
271 * @vol: volume description object 272 * @vol: volume description object
272 * @buf: write data (user-space memory buffer) 273 * @buf: write data (user-space memory buffer)
273 * @count: how much bytes to write 274 * @count: how much bytes to write
@@ -385,6 +386,7 @@ int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
385 386
386/** 387/**
387 * ubi_more_leb_change_data - accept more data for atomic LEB change. 388 * ubi_more_leb_change_data - accept more data for atomic LEB change.
389 * @ubi: UBI device description object
388 * @vol: volume description object 390 * @vol: volume description object
389 * @buf: write data (user-space memory buffer) 391 * @buf: write data (user-space memory buffer)
390 * @count: how much bytes to write 392 * @count: how much bytes to write
diff --git a/drivers/mtd/ubi/vmt.c b/drivers/mtd/ubi/vmt.c
index 852482d8b18f..d40066833abb 100644
--- a/drivers/mtd/ubi/vmt.c
+++ b/drivers/mtd/ubi/vmt.c
@@ -608,7 +608,7 @@ out_free:
608/** 608/**
609 * ubi_rename_volumes - re-name UBI volumes. 609 * ubi_rename_volumes - re-name UBI volumes.
610 * @ubi: UBI device description object 610 * @ubi: UBI device description object
611 * @renam_list: list of &struct ubi_rename_entry objects 611 * @rename_list: list of &struct ubi_rename_entry objects
612 * 612 *
613 * This function re-names or removes volumes specified in the re-name list. 613 * This function re-names or removes volumes specified in the re-name list.
614 * Returns zero in case of success and a negative error code in case of 614 * Returns zero in case of success and a negative error code in case of
diff --git a/drivers/mtd/ubi/vtbl.c b/drivers/mtd/ubi/vtbl.c
index 10c22257f601..4e1c489a3bae 100644
--- a/drivers/mtd/ubi/vtbl.c
+++ b/drivers/mtd/ubi/vtbl.c
@@ -117,7 +117,7 @@ int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
117/** 117/**
118 * ubi_vtbl_rename_volumes - rename UBI volumes in the volume table. 118 * ubi_vtbl_rename_volumes - rename UBI volumes in the volume table.
119 * @ubi: UBI device description object 119 * @ubi: UBI device description object
120 * @renam_list: list of &struct ubi_rename_entry objects 120 * @rename_list: list of &struct ubi_rename_entry objects
121 * 121 *
122 * This function re-names multiple volumes specified in @req in the volume 122 * This function re-names multiple volumes specified in @req in the volume
123 * table. Returns zero in case of success and a negative error code in case of 123 * 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,
166} 166}
167 167
168/** 168/**
169 * vtbl_check - check if volume table is not corrupted and contains sensible 169 * vtbl_check - check if volume table is not corrupted and sensible.
170 * data.
171 * @ubi: UBI device description object 170 * @ubi: UBI device description object
172 * @vtbl: volume table 171 * @vtbl: volume table
173 * 172 *
@@ -780,8 +779,7 @@ static int check_scanning_info(const struct ubi_device *ubi,
780} 779}
781 780
782/** 781/**
783 * ubi_read_volume_table - read volume table. 782 * ubi_read_volume_table - read the volume table.
784 * information.
785 * @ubi: UBI device description object 783 * @ubi: UBI device description object
786 * @si: scanning information 784 * @si: scanning information
787 * 785 *
diff --git a/drivers/mtd/ubi/wl.c b/drivers/mtd/ubi/wl.c
index 2a5d2a0e14ad..05d70937b543 100644
--- a/drivers/mtd/ubi/wl.c
+++ b/drivers/mtd/ubi/wl.c
@@ -632,8 +632,7 @@ out_free:
632} 632}
633 633
634/** 634/**
635 * check_protection_over - check if it is time to stop protecting some 635 * check_protection_over - check if it is time to stop protecting some PEBs.
636 * physical eraseblocks.
637 * @ubi: UBI device description object 636 * @ubi: UBI device description object
638 * 637 *
639 * This function is called after each erase operation, when the absolute erase 638 * This function is called after each erase operation, when the absolute erase
@@ -1601,8 +1600,7 @@ void ubi_wl_close(struct ubi_device *ubi)
1601#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID 1600#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1602 1601
1603/** 1602/**
1604 * paranoid_check_ec - make sure that the erase counter of a physical eraseblock 1603 * paranoid_check_ec - make sure that the erase counter of a PEB is correct.
1605 * is correct.
1606 * @ubi: UBI device description object 1604 * @ubi: UBI device description object
1607 * @pnum: the physical eraseblock number to check 1605 * @pnum: the physical eraseblock number to check
1608 * @ec: the erase counter to check 1606 * @ec: the erase counter to check
@@ -1643,13 +1641,12 @@ out_free:
1643} 1641}
1644 1642
1645/** 1643/**
1646 * paranoid_check_in_wl_tree - make sure that a wear-leveling entry is present 1644 * paranoid_check_in_wl_tree - check that wear-leveling entry is in WL RB-tree.
1647 * in a WL RB-tree.
1648 * @e: the wear-leveling entry to check 1645 * @e: the wear-leveling entry to check
1649 * @root: the root of the tree 1646 * @root: the root of the tree
1650 * 1647 *
1651 * This function returns zero if @e is in the @root RB-tree and %1 if it 1648 * This function returns zero if @e is in the @root RB-tree and %1 if it is
1652 * is not. 1649 * not.
1653 */ 1650 */
1654static int paranoid_check_in_wl_tree(struct ubi_wl_entry *e, 1651static int paranoid_check_in_wl_tree(struct ubi_wl_entry *e,
1655 struct rb_root *root) 1652 struct rb_root *root)