166 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			C
		
	
	
	
			
		
		
	
	
			166 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			C
		
	
	
	
| /*
 | |
|  * Copyright (c) International Business Machines Corp., 2006
 | |
|  *
 | |
|  * This program is free software; you can redistribute it and/or modify
 | |
|  * it under the terms of the GNU General Public License as published by
 | |
|  * the Free Software Foundation; either version 2 of the License, or
 | |
|  * (at your option) any later version.
 | |
|  *
 | |
|  * This program is distributed in the hope that it will be useful,
 | |
|  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | |
|  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
 | |
|  * the GNU General Public License for more details.
 | |
|  *
 | |
|  * You should have received a copy of the GNU General Public License
 | |
|  * along with this program; if not, write to the Free Software
 | |
|  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 | |
|  *
 | |
|  * Author: Artem Bityutskiy (Битюцкий Артём)
 | |
|  */
 | |
| 
 | |
| #ifndef __UBI_SCAN_H__
 | |
| #define __UBI_SCAN_H__
 | |
| 
 | |
| /* The erase counter value for this physical eraseblock is unknown */
 | |
| #define UBI_SCAN_UNKNOWN_EC (-1)
 | |
| 
 | |
| /**
 | |
|  * struct ubi_scan_leb - scanning information about a physical eraseblock.
 | |
|  * @ec: erase counter (%UBI_SCAN_UNKNOWN_EC if it is unknown)
 | |
|  * @pnum: physical eraseblock number
 | |
|  * @lnum: logical eraseblock number
 | |
|  * @scrub: if this physical eraseblock needs scrubbing
 | |
|  * @sqnum: sequence number
 | |
|  * @u: unions RB-tree or @list links
 | |
|  * @u.rb: link in the per-volume RB-tree of &struct ubi_scan_leb objects
 | |
|  * @u.list: link in one of the eraseblock lists
 | |
|  * @leb_ver: logical eraseblock version (obsolete)
 | |
|  *
 | |
|  * One object of this type is allocated for each physical eraseblock during
 | |
|  * scanning.
 | |
|  */
 | |
| struct ubi_scan_leb {
 | |
| 	int ec;
 | |
| 	int pnum;
 | |
| 	int lnum;
 | |
| 	int scrub;
 | |
| 	unsigned long long sqnum;
 | |
| 	union {
 | |
| 		struct rb_node rb;
 | |
| 		struct list_head list;
 | |
| 	} u;
 | |
| 	uint32_t leb_ver;
 | |
| };
 | |
| 
 | |
| /**
 | |
|  * struct ubi_scan_volume - scanning information about a volume.
 | |
|  * @vol_id: volume ID
 | |
|  * @highest_lnum: highest logical eraseblock number in this volume
 | |
|  * @leb_count: number of logical eraseblocks in this volume
 | |
|  * @vol_type: volume type
 | |
|  * @used_ebs: number of used logical eraseblocks in this volume (only for
 | |
|  * static volumes)
 | |
|  * @last_data_size: amount of data in the last logical eraseblock of this
 | |
|  * volume (always equivalent to the usable logical eraseblock size in case of
 | |
|  * dynamic volumes)
 | |
|  * @data_pad: how many bytes at the end of logical eraseblocks of this volume
 | |
|  * are not used (due to volume alignment)
 | |
|  * @compat: compatibility flags of this volume
 | |
|  * @rb: link in the volume RB-tree
 | |
|  * @root: root of the RB-tree containing all the eraseblock belonging to this
 | |
|  * volume (&struct ubi_scan_leb objects)
 | |
|  *
 | |
|  * One object of this type is allocated for each volume during scanning.
 | |
|  */
 | |
| struct ubi_scan_volume {
 | |
| 	int vol_id;
 | |
| 	int highest_lnum;
 | |
| 	int leb_count;
 | |
| 	int vol_type;
 | |
| 	int used_ebs;
 | |
| 	int last_data_size;
 | |
| 	int data_pad;
 | |
| 	int compat;
 | |
| 	struct rb_node rb;
 | |
| 	struct rb_root root;
 | |
| };
 | |
| 
 | |
| /**
 | |
|  * struct ubi_scan_info - UBI scanning information.
 | |
|  * @volumes: root of the volume RB-tree
 | |
|  * @corr: list of corrupted physical eraseblocks
 | |
|  * @free: list of free physical eraseblocks
 | |
|  * @erase: list of physical eraseblocks which have to be erased
 | |
|  * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
 | |
|  * @bad_peb_count: count of bad physical eraseblocks
 | |
|  * those belonging to "preserve"-compatible internal volumes)
 | |
|  * @vols_found: number of volumes found during scanning
 | |
|  * @highest_vol_id: highest volume ID
 | |
|  * @alien_peb_count: count of physical eraseblocks in the @alien list
 | |
|  * @is_empty: flag indicating whether the MTD device is empty or not
 | |
|  * @min_ec: lowest erase counter value
 | |
|  * @max_ec: highest erase counter value
 | |
|  * @max_sqnum: highest sequence number value
 | |
|  * @mean_ec: mean erase counter value
 | |
|  * @ec_sum: a temporary variable used when calculating @mean_ec
 | |
|  * @ec_count: a temporary variable used when calculating @mean_ec
 | |
|  *
 | |
|  * This data structure contains the result of scanning and may be used by other
 | |
|  * UBI units to build final UBI data structures, further error-recovery and so
 | |
|  * on.
 | |
|  */
 | |
| struct ubi_scan_info {
 | |
| 	struct rb_root volumes;
 | |
| 	struct list_head corr;
 | |
| 	struct list_head free;
 | |
| 	struct list_head erase;
 | |
| 	struct list_head alien;
 | |
| 	int bad_peb_count;
 | |
| 	int vols_found;
 | |
| 	int highest_vol_id;
 | |
| 	int alien_peb_count;
 | |
| 	int is_empty;
 | |
| 	int min_ec;
 | |
| 	int max_ec;
 | |
| 	unsigned long long max_sqnum;
 | |
| 	int mean_ec;
 | |
| 	uint64_t ec_sum;
 | |
| 	int ec_count;
 | |
| };
 | |
| 
 | |
| struct ubi_device;
 | |
| struct ubi_vid_hdr;
 | |
| 
 | |
| /*
 | |
|  * ubi_scan_move_to_list - move a physical eraseblock from the volume tree to a
 | |
|  * list.
 | |
|  *
 | |
|  * @sv: volume scanning information
 | |
|  * @seb: scanning eraseblock infprmation
 | |
|  * @list: the list to move to
 | |
|  */
 | |
| static inline void ubi_scan_move_to_list(struct ubi_scan_volume *sv,
 | |
| 					 struct ubi_scan_leb *seb,
 | |
| 					 struct list_head *list)
 | |
| {
 | |
| 		rb_erase(&seb->u.rb, &sv->root);
 | |
| 		list_add_tail(&seb->u.list, list);
 | |
| }
 | |
| 
 | |
| int ubi_scan_add_used(struct ubi_device *ubi, struct ubi_scan_info *si,
 | |
| 		      int pnum, int ec, const struct ubi_vid_hdr *vid_hdr,
 | |
| 		      int bitflips);
 | |
| struct ubi_scan_volume *ubi_scan_find_sv(const struct ubi_scan_info *si,
 | |
| 					 int vol_id);
 | |
| struct ubi_scan_leb *ubi_scan_find_seb(const struct ubi_scan_volume *sv,
 | |
| 				       int lnum);
 | |
| void ubi_scan_rm_volume(struct ubi_scan_info *si, struct ubi_scan_volume *sv);
 | |
| struct ubi_scan_leb *ubi_scan_get_free_peb(struct ubi_device *ubi,
 | |
| 					   struct ubi_scan_info *si);
 | |
| int ubi_scan_erase_peb(struct ubi_device *ubi, const struct ubi_scan_info *si,
 | |
| 		       int pnum, int ec);
 | |
| struct ubi_scan_info *ubi_scan(struct ubi_device *ubi);
 | |
| void ubi_scan_destroy_si(struct ubi_scan_info *si);
 | |
| 
 | |
| #endif /* !__UBI_SCAN_H__ */
 |