1801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/* 2801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * Copyright (c) International Business Machines Corp., 2006 3801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 4801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * This program is free software; you can redistribute it and/or modify 5801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * it under the terms of the GNU General Public License as published by 6801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * the Free Software Foundation; either version 2 of the License, or 7801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * (at your option) any later version. 8801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 9801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * This program is distributed in the hope that it will be useful, 10801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * but WITHOUT ANY WARRANTY; without even the implied warranty of 11801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 12801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * the GNU General Public License for more details. 13801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 14801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * You should have received a copy of the GNU General Public License 15801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * along with this program; if not, write to the Free Software 16801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 17801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 18801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * Author: Artem Bityutskiy (Битюцкий Артём) 19801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy */ 20801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 21801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy#ifndef __UBI_SCAN_H__ 22801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy#define __UBI_SCAN_H__ 23801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 24801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/* The erase counter value for this physical eraseblock is unknown */ 25801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy#define UBI_SCAN_UNKNOWN_EC (-1) 26801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 27801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/** 28801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * struct ubi_scan_leb - scanning information about a physical eraseblock. 29801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @ec: erase counter (%UBI_SCAN_UNKNOWN_EC if it is unknown) 30801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @pnum: physical eraseblock number 31801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @lnum: logical eraseblock number 32801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @scrub: if this physical eraseblock needs scrubbing 33fb22b59b2c38054cc847f6acc5c46daa26dc6dd3Artem Bityutskiy * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB) 34801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @sqnum: sequence number 35801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @u: unions RB-tree or @list links 36801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @u.rb: link in the per-volume RB-tree of &struct ubi_scan_leb objects 37801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @u.list: link in one of the eraseblock lists 38801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 39801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * One object of this type is allocated for each physical eraseblock during 40801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * scanning. 41801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy */ 42801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_leb { 43801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int ec; 44801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int pnum; 45801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int lnum; 46fb22b59b2c38054cc847f6acc5c46daa26dc6dd3Artem Bityutskiy unsigned int scrub:1; 47fb22b59b2c38054cc847f6acc5c46daa26dc6dd3Artem Bityutskiy unsigned int copy_flag:1; 48801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy unsigned long long sqnum; 49801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy union { 50801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct rb_node rb; 51801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head list; 52801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy } u; 53801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy}; 54801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 55801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/** 56801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * struct ubi_scan_volume - scanning information about a volume. 57801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @vol_id: volume ID 58801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @highest_lnum: highest logical eraseblock number in this volume 59801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @leb_count: number of logical eraseblocks in this volume 60801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @vol_type: volume type 61801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @used_ebs: number of used logical eraseblocks in this volume (only for 6285c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * static volumes) 63801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @last_data_size: amount of data in the last logical eraseblock of this 6485c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * volume (always equivalent to the usable logical eraseblock 6585c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * size in case of dynamic volumes) 66801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @data_pad: how many bytes at the end of logical eraseblocks of this volume 6785c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * are not used (due to volume alignment) 68801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @compat: compatibility flags of this volume 69801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @rb: link in the volume RB-tree 70801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @root: root of the RB-tree containing all the eraseblock belonging to this 7185c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * volume (&struct ubi_scan_leb objects) 72801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 73801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * One object of this type is allocated for each volume during scanning. 74801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy */ 75801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_volume { 76801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int vol_id; 77801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int highest_lnum; 78801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int leb_count; 79801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int vol_type; 80801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int used_ebs; 81801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int last_data_size; 82801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int data_pad; 83801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int compat; 84801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct rb_node rb; 85801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct rb_root root; 86801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy}; 87801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 88801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/** 89801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * struct ubi_scan_info - UBI scanning information. 90801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @volumes: root of the volume RB-tree 91801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @corr: list of corrupted physical eraseblocks 92801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @free: list of free physical eraseblocks 93801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @erase: list of physical eraseblocks which have to be erased 94801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @alien: list of physical eraseblocks which should not be used by UBI (e.g., 9585c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * those belonging to "preserve"-compatible internal volumes) 9633789fb9d4470e27d18596c0966339e2ca8865a9Artem Bityutskiy * @corr_peb_count: count of PEBs in the @corr list 970525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy * @empty_peb_count: count of PEBs which are presumably empty (contain only 980525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy * 0xFF bytes) 9933789fb9d4470e27d18596c0966339e2ca8865a9Artem Bityutskiy * @alien_peb_count: count of PEBs in the @alien list 100801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @bad_peb_count: count of bad physical eraseblocks 1010525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked 1020525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy * as bad yet, but which look like bad 103801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @vols_found: number of volumes found during scanning 104801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @highest_vol_id: highest volume ID 105801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @is_empty: flag indicating whether the MTD device is empty or not 106801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @min_ec: lowest erase counter value 107801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @max_ec: highest erase counter value 108801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @max_sqnum: highest sequence number value 109801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @mean_ec: mean erase counter value 110801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @ec_sum: a temporary variable used when calculating @mean_ec 111801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @ec_count: a temporary variable used when calculating @mean_ec 1126c1e875ca6f3a47b40dce715bd07fdfdb8388d55Artem Bityutskiy * @scan_leb_slab: slab cache for &struct ubi_scan_leb objects 113801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 114801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * This data structure contains the result of scanning and may be used by other 11585c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * UBI sub-systems to build final UBI data structures, further error-recovery 11685c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * and so on. 117801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy */ 118801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_info { 119801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct rb_root volumes; 120801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head corr; 121801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head free; 122801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head erase; 123801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head alien; 12433789fb9d4470e27d18596c0966339e2ca8865a9Artem Bityutskiy int corr_peb_count; 1250525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy int empty_peb_count; 12633789fb9d4470e27d18596c0966339e2ca8865a9Artem Bityutskiy int alien_peb_count; 127801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int bad_peb_count; 1280525dac9fd31e5a12fb934238abd09e2752a5967Artem Bityutskiy int maybe_bad_peb_count; 129801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int vols_found; 130801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int highest_vol_id; 131801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int is_empty; 132801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int min_ec; 133801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int max_ec; 134801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy unsigned long long max_sqnum; 135801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int mean_ec; 1364bc1dca4b0eb4dfbf100895bfc1256f21e3c901aArtem Bityutskiy uint64_t ec_sum; 137801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int ec_count; 1386c1e875ca6f3a47b40dce715bd07fdfdb8388d55Artem Bityutskiy struct kmem_cache *scan_leb_slab; 139801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy}; 140801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 141801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_device; 142801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_vid_hdr; 143801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 144801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy/* 14585c6e6e28259e9b58b8984db536c45bc3161f40cArtem Bityutskiy * ubi_scan_move_to_list - move a PEB from the volume tree to a list. 146801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * 147801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @sv: volume scanning information 14833789fb9d4470e27d18596c0966339e2ca8865a9Artem Bityutskiy * @seb: scanning eraseblock information 149801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy * @list: the list to move to 150801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy */ 151801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystatic inline void ubi_scan_move_to_list(struct ubi_scan_volume *sv, 152801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct ubi_scan_leb *seb, 153801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct list_head *list) 154801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy{ 155801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy rb_erase(&seb->u.rb, &sv->root); 156801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy list_add_tail(&seb->u.list, list); 157801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy} 158801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 159e88d6e10e5c848fd5be8f89e09e3bce2570886b7Artem Bityutskiyint ubi_scan_add_used(struct ubi_device *ubi, struct ubi_scan_info *si, 160801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int pnum, int ec, const struct ubi_vid_hdr *vid_hdr, 161801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int bitflips); 162801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_volume *ubi_scan_find_sv(const struct ubi_scan_info *si, 163801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int vol_id); 164801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_leb *ubi_scan_find_seb(const struct ubi_scan_volume *sv, 165801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy int lnum); 166801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiyvoid ubi_scan_rm_volume(struct ubi_scan_info *si, struct ubi_scan_volume *sv); 167e88d6e10e5c848fd5be8f89e09e3bce2570886b7Artem Bityutskiystruct ubi_scan_leb *ubi_scan_get_free_peb(struct ubi_device *ubi, 168801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy struct ubi_scan_info *si); 169e88d6e10e5c848fd5be8f89e09e3bce2570886b7Artem Bityutskiyint ubi_scan_erase_peb(struct ubi_device *ubi, const struct ubi_scan_info *si, 170e88d6e10e5c848fd5be8f89e09e3bce2570886b7Artem Bityutskiy int pnum, int ec); 171801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiystruct ubi_scan_info *ubi_scan(struct ubi_device *ubi); 172801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiyvoid ubi_scan_destroy_si(struct ubi_scan_info *si); 173801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy 174801c135ce73d5df1caf3eca35b66a10824ae0707Artem B. Bityutskiy#endif /* !__UBI_SCAN_H__ */ 175