aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/mtd/ubi/scan.h
diff options
context:
space:
mode:
authorArtem Bityutskiy <Artem.Bityutskiy@nokia.com>2008-07-16 03:25:56 -0400
committerArtem Bityutskiy <Artem.Bityutskiy@nokia.com>2008-07-24 06:32:56 -0400
commit85c6e6e28259e9b58b8984db536c45bc3161f40c (patch)
treef389adfe74753f318290b45b7ce190421d18c48e /drivers/mtd/ubi/scan.h
parentbb84c1a199558962edf4b4aeb4480fb09aa09b91 (diff)
UBI: amend commentaries
Hch asked not to use "unit" for sub-systems, let it be so. Also some other commentaries modifications. Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy@nokia.com>
Diffstat (limited to 'drivers/mtd/ubi/scan.h')
-rw-r--r--drivers/mtd/ubi/scan.h19
1 files changed, 9 insertions, 10 deletions
diff --git a/drivers/mtd/ubi/scan.h b/drivers/mtd/ubi/scan.h
index 966b9b682a42..4e2e3cc0becd 100644
--- a/drivers/mtd/ubi/scan.h
+++ b/drivers/mtd/ubi/scan.h
@@ -59,16 +59,16 @@ struct ubi_scan_leb {
59 * @leb_count: number of logical eraseblocks in this volume 59 * @leb_count: number of logical eraseblocks in this volume
60 * @vol_type: volume type 60 * @vol_type: volume type
61 * @used_ebs: number of used logical eraseblocks in this volume (only for 61 * @used_ebs: number of used logical eraseblocks in this volume (only for
62 * static volumes) 62 * static volumes)
63 * @last_data_size: amount of data in the last logical eraseblock of this 63 * @last_data_size: amount of data in the last logical eraseblock of this
64 * volume (always equivalent to the usable logical eraseblock size in case of 64 * volume (always equivalent to the usable logical eraseblock
65 * dynamic volumes) 65 * size in case of dynamic volumes)
66 * @data_pad: how many bytes at the end of logical eraseblocks of this volume 66 * @data_pad: how many bytes at the end of logical eraseblocks of this volume
67 * are not used (due to volume alignment) 67 * are not used (due to volume alignment)
68 * @compat: compatibility flags of this volume 68 * @compat: compatibility flags of this volume
69 * @rb: link in the volume RB-tree 69 * @rb: link in the volume RB-tree
70 * @root: root of the RB-tree containing all the eraseblock belonging to this 70 * @root: root of the RB-tree containing all the eraseblock belonging to this
71 * volume (&struct ubi_scan_leb objects) 71 * volume (&struct ubi_scan_leb objects)
72 * 72 *
73 * One object of this type is allocated for each volume during scanning. 73 * One object of this type is allocated for each volume during scanning.
74 */ 74 */
@@ -92,8 +92,8 @@ struct ubi_scan_volume {
92 * @free: list of free physical eraseblocks 92 * @free: list of free physical eraseblocks
93 * @erase: list of physical eraseblocks which have to be erased 93 * @erase: list of physical eraseblocks which have to be erased
94 * @alien: list of physical eraseblocks which should not be used by UBI (e.g., 94 * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
95 * those belonging to "preserve"-compatible internal volumes)
95 * @bad_peb_count: count of bad physical eraseblocks 96 * @bad_peb_count: count of bad physical eraseblocks
96 * those belonging to "preserve"-compatible internal volumes)
97 * @vols_found: number of volumes found during scanning 97 * @vols_found: number of volumes found during scanning
98 * @highest_vol_id: highest volume ID 98 * @highest_vol_id: highest volume ID
99 * @alien_peb_count: count of physical eraseblocks in the @alien list 99 * @alien_peb_count: count of physical eraseblocks in the @alien list
@@ -106,8 +106,8 @@ struct ubi_scan_volume {
106 * @ec_count: a temporary variable used when calculating @mean_ec 106 * @ec_count: a temporary variable used when calculating @mean_ec
107 * 107 *
108 * This data structure contains the result of scanning and may be used by other 108 * This data structure contains the result of scanning and may be used by other
109 * UBI units to build final UBI data structures, further error-recovery and so 109 * UBI sub-systems to build final UBI data structures, further error-recovery
110 * on. 110 * and so on.
111 */ 111 */
112struct ubi_scan_info { 112struct ubi_scan_info {
113 struct rb_root volumes; 113 struct rb_root volumes;
@@ -132,8 +132,7 @@ struct ubi_device;
132struct ubi_vid_hdr; 132struct ubi_vid_hdr;
133 133
134/* 134/*
135 * ubi_scan_move_to_list - move a physical eraseblock from the volume tree to a 135 * ubi_scan_move_to_list - move a PEB from the volume tree to a list.
136 * list.
137 * 136 *
138 * @sv: volume scanning information 137 * @sv: volume scanning information
139 * @seb: scanning eraseblock infprmation 138 * @seb: scanning eraseblock infprmation