xref: /rk3399_rockchip-uboot/drivers/mtd/ubi/ubi.h (revision f412fefa079c6aa9a9763f6869bf787ea6bf6e1b)
1*f412fefaSKyungmin Park /*
2*f412fefaSKyungmin Park  * Copyright (c) International Business Machines Corp., 2006
3*f412fefaSKyungmin Park  * Copyright (c) Nokia Corporation, 2006, 2007
4*f412fefaSKyungmin Park  *
5*f412fefaSKyungmin Park  * This program is free software; you can redistribute it and/or modify
6*f412fefaSKyungmin Park  * it under the terms of the GNU General Public License as published by
7*f412fefaSKyungmin Park  * the Free Software Foundation; either version 2 of the License, or
8*f412fefaSKyungmin Park  * (at your option) any later version.
9*f412fefaSKyungmin Park  *
10*f412fefaSKyungmin Park  * This program is distributed in the hope that it will be useful,
11*f412fefaSKyungmin Park  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12*f412fefaSKyungmin Park  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13*f412fefaSKyungmin Park  * the GNU General Public License for more details.
14*f412fefaSKyungmin Park  *
15*f412fefaSKyungmin Park  * You should have received a copy of the GNU General Public License
16*f412fefaSKyungmin Park  * along with this program; if not, write to the Free Software
17*f412fefaSKyungmin Park  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18*f412fefaSKyungmin Park  *
19*f412fefaSKyungmin Park  * Author: Artem Bityutskiy (Битюцкий Артём)
20*f412fefaSKyungmin Park  */
21*f412fefaSKyungmin Park 
22*f412fefaSKyungmin Park #ifndef __UBI_UBI_H__
23*f412fefaSKyungmin Park #define __UBI_UBI_H__
24*f412fefaSKyungmin Park 
25*f412fefaSKyungmin Park #ifdef UBI_LINUX
26*f412fefaSKyungmin Park #include <linux/init.h>
27*f412fefaSKyungmin Park #include <linux/types.h>
28*f412fefaSKyungmin Park #include <linux/list.h>
29*f412fefaSKyungmin Park #include <linux/rbtree.h>
30*f412fefaSKyungmin Park #include <linux/sched.h>
31*f412fefaSKyungmin Park #include <linux/wait.h>
32*f412fefaSKyungmin Park #include <linux/mutex.h>
33*f412fefaSKyungmin Park #include <linux/rwsem.h>
34*f412fefaSKyungmin Park #include <linux/spinlock.h>
35*f412fefaSKyungmin Park #include <linux/fs.h>
36*f412fefaSKyungmin Park #include <linux/cdev.h>
37*f412fefaSKyungmin Park #include <linux/device.h>
38*f412fefaSKyungmin Park #include <linux/string.h>
39*f412fefaSKyungmin Park #include <linux/vmalloc.h>
40*f412fefaSKyungmin Park #include <linux/mtd/mtd.h>
41*f412fefaSKyungmin Park #include <linux/mtd/ubi.h>
42*f412fefaSKyungmin Park #endif
43*f412fefaSKyungmin Park 
44*f412fefaSKyungmin Park #include <linux/types.h>
45*f412fefaSKyungmin Park #include <linux/list.h>
46*f412fefaSKyungmin Park #include <linux/rbtree.h>
47*f412fefaSKyungmin Park #include <linux/string.h>
48*f412fefaSKyungmin Park #include <linux/mtd/mtd.h>
49*f412fefaSKyungmin Park #include <linux/mtd/ubi.h>
50*f412fefaSKyungmin Park 
51*f412fefaSKyungmin Park #include "ubi-media.h"
52*f412fefaSKyungmin Park #include "scan.h"
53*f412fefaSKyungmin Park #include "debug.h"
54*f412fefaSKyungmin Park 
55*f412fefaSKyungmin Park /* Maximum number of supported UBI devices */
56*f412fefaSKyungmin Park #define UBI_MAX_DEVICES 32
57*f412fefaSKyungmin Park 
58*f412fefaSKyungmin Park /* UBI name used for character devices, sysfs, etc */
59*f412fefaSKyungmin Park #define UBI_NAME_STR "ubi"
60*f412fefaSKyungmin Park 
61*f412fefaSKyungmin Park /* Normal UBI messages */
62*f412fefaSKyungmin Park #define ubi_msg(fmt, ...) printk(KERN_NOTICE "UBI: " fmt "\n", ##__VA_ARGS__)
63*f412fefaSKyungmin Park /* UBI warning messages */
64*f412fefaSKyungmin Park #define ubi_warn(fmt, ...) printk(KERN_WARNING "UBI warning: %s: " fmt "\n", \
65*f412fefaSKyungmin Park 				  __func__, ##__VA_ARGS__)
66*f412fefaSKyungmin Park /* UBI error messages */
67*f412fefaSKyungmin Park #define ubi_err(fmt, ...) printk(KERN_ERR "UBI error: %s: " fmt "\n", \
68*f412fefaSKyungmin Park 				 __func__, ##__VA_ARGS__)
69*f412fefaSKyungmin Park 
70*f412fefaSKyungmin Park /* Lowest number PEBs reserved for bad PEB handling */
71*f412fefaSKyungmin Park #define MIN_RESEVED_PEBS 2
72*f412fefaSKyungmin Park 
73*f412fefaSKyungmin Park /* Background thread name pattern */
74*f412fefaSKyungmin Park #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
75*f412fefaSKyungmin Park 
76*f412fefaSKyungmin Park /* This marker in the EBA table means that the LEB is um-mapped */
77*f412fefaSKyungmin Park #define UBI_LEB_UNMAPPED -1
78*f412fefaSKyungmin Park 
79*f412fefaSKyungmin Park /*
80*f412fefaSKyungmin Park  * In case of errors, UBI tries to repeat the operation several times before
81*f412fefaSKyungmin Park  * returning error. The below constant defines how many times UBI re-tries.
82*f412fefaSKyungmin Park  */
83*f412fefaSKyungmin Park #define UBI_IO_RETRIES 3
84*f412fefaSKyungmin Park 
85*f412fefaSKyungmin Park /*
86*f412fefaSKyungmin Park  * Error codes returned by the I/O unit.
87*f412fefaSKyungmin Park  *
88*f412fefaSKyungmin Park  * UBI_IO_PEB_EMPTY: the physical eraseblock is empty, i.e. it contains only
89*f412fefaSKyungmin Park  * 0xFF bytes
90*f412fefaSKyungmin Park  * UBI_IO_PEB_FREE: the physical eraseblock is free, i.e. it contains only a
91*f412fefaSKyungmin Park  * valid erase counter header, and the rest are %0xFF bytes
92*f412fefaSKyungmin Park  * UBI_IO_BAD_EC_HDR: the erase counter header is corrupted (bad magic or CRC)
93*f412fefaSKyungmin Park  * UBI_IO_BAD_VID_HDR: the volume identifier header is corrupted (bad magic or
94*f412fefaSKyungmin Park  * CRC)
95*f412fefaSKyungmin Park  * UBI_IO_BITFLIPS: bit-flips were detected and corrected
96*f412fefaSKyungmin Park  */
97*f412fefaSKyungmin Park enum {
98*f412fefaSKyungmin Park 	UBI_IO_PEB_EMPTY = 1,
99*f412fefaSKyungmin Park 	UBI_IO_PEB_FREE,
100*f412fefaSKyungmin Park 	UBI_IO_BAD_EC_HDR,
101*f412fefaSKyungmin Park 	UBI_IO_BAD_VID_HDR,
102*f412fefaSKyungmin Park 	UBI_IO_BITFLIPS
103*f412fefaSKyungmin Park };
104*f412fefaSKyungmin Park 
105*f412fefaSKyungmin Park /**
106*f412fefaSKyungmin Park  * struct ubi_wl_entry - wear-leveling entry.
107*f412fefaSKyungmin Park  * @rb: link in the corresponding RB-tree
108*f412fefaSKyungmin Park  * @ec: erase counter
109*f412fefaSKyungmin Park  * @pnum: physical eraseblock number
110*f412fefaSKyungmin Park  *
111*f412fefaSKyungmin Park  * This data structure is used in the WL unit. Each physical eraseblock has a
112*f412fefaSKyungmin Park  * corresponding &struct wl_entry object which may be kept in different
113*f412fefaSKyungmin Park  * RB-trees. See WL unit for details.
114*f412fefaSKyungmin Park  */
115*f412fefaSKyungmin Park struct ubi_wl_entry {
116*f412fefaSKyungmin Park 	struct rb_node rb;
117*f412fefaSKyungmin Park 	int ec;
118*f412fefaSKyungmin Park 	int pnum;
119*f412fefaSKyungmin Park };
120*f412fefaSKyungmin Park 
121*f412fefaSKyungmin Park /**
122*f412fefaSKyungmin Park  * struct ubi_ltree_entry - an entry in the lock tree.
123*f412fefaSKyungmin Park  * @rb: links RB-tree nodes
124*f412fefaSKyungmin Park  * @vol_id: volume ID of the locked logical eraseblock
125*f412fefaSKyungmin Park  * @lnum: locked logical eraseblock number
126*f412fefaSKyungmin Park  * @users: how many tasks are using this logical eraseblock or wait for it
127*f412fefaSKyungmin Park  * @mutex: read/write mutex to implement read/write access serialization to
128*f412fefaSKyungmin Park  *         the (@vol_id, @lnum) logical eraseblock
129*f412fefaSKyungmin Park  *
130*f412fefaSKyungmin Park  * This data structure is used in the EBA unit to implement per-LEB locking.
131*f412fefaSKyungmin Park  * When a logical eraseblock is being locked - corresponding
132*f412fefaSKyungmin Park  * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
133*f412fefaSKyungmin Park  * See EBA unit for details.
134*f412fefaSKyungmin Park  */
135*f412fefaSKyungmin Park struct ubi_ltree_entry {
136*f412fefaSKyungmin Park 	struct rb_node rb;
137*f412fefaSKyungmin Park 	int vol_id;
138*f412fefaSKyungmin Park 	int lnum;
139*f412fefaSKyungmin Park 	int users;
140*f412fefaSKyungmin Park 	struct rw_semaphore mutex;
141*f412fefaSKyungmin Park };
142*f412fefaSKyungmin Park 
143*f412fefaSKyungmin Park struct ubi_volume_desc;
144*f412fefaSKyungmin Park 
145*f412fefaSKyungmin Park /**
146*f412fefaSKyungmin Park  * struct ubi_volume - UBI volume description data structure.
147*f412fefaSKyungmin Park  * @dev: device object to make use of the the Linux device model
148*f412fefaSKyungmin Park  * @cdev: character device object to create character device
149*f412fefaSKyungmin Park  * @ubi: reference to the UBI device description object
150*f412fefaSKyungmin Park  * @vol_id: volume ID
151*f412fefaSKyungmin Park  * @ref_count: volume reference count
152*f412fefaSKyungmin Park  * @readers: number of users holding this volume in read-only mode
153*f412fefaSKyungmin Park  * @writers: number of users holding this volume in read-write mode
154*f412fefaSKyungmin Park  * @exclusive: whether somebody holds this volume in exclusive mode
155*f412fefaSKyungmin Park  *
156*f412fefaSKyungmin Park  * @reserved_pebs: how many physical eraseblocks are reserved for this volume
157*f412fefaSKyungmin Park  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
158*f412fefaSKyungmin Park  * @usable_leb_size: logical eraseblock size without padding
159*f412fefaSKyungmin Park  * @used_ebs: how many logical eraseblocks in this volume contain data
160*f412fefaSKyungmin Park  * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
161*f412fefaSKyungmin Park  * @used_bytes: how many bytes of data this volume contains
162*f412fefaSKyungmin Park  * @alignment: volume alignment
163*f412fefaSKyungmin Park  * @data_pad: how many bytes are not used at the end of physical eraseblocks to
164*f412fefaSKyungmin Park  *            satisfy the requested alignment
165*f412fefaSKyungmin Park  * @name_len: volume name length
166*f412fefaSKyungmin Park  * @name: volume name
167*f412fefaSKyungmin Park  *
168*f412fefaSKyungmin Park  * @upd_ebs: how many eraseblocks are expected to be updated
169*f412fefaSKyungmin Park  * @ch_lnum: LEB number which is being changing by the atomic LEB change
170*f412fefaSKyungmin Park  *           operation
171*f412fefaSKyungmin Park  * @ch_dtype: data persistency type which is being changing by the atomic LEB
172*f412fefaSKyungmin Park  *            change operation
173*f412fefaSKyungmin Park  * @upd_bytes: how many bytes are expected to be received for volume update or
174*f412fefaSKyungmin Park  *             atomic LEB change
175*f412fefaSKyungmin Park  * @upd_received: how many bytes were already received for volume update or
176*f412fefaSKyungmin Park  *                atomic LEB change
177*f412fefaSKyungmin Park  * @upd_buf: update buffer which is used to collect update data or data for
178*f412fefaSKyungmin Park  *           atomic LEB change
179*f412fefaSKyungmin Park  *
180*f412fefaSKyungmin Park  * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
181*f412fefaSKyungmin Park  * @checked: %1 if this static volume was checked
182*f412fefaSKyungmin Park  * @corrupted: %1 if the volume is corrupted (static volumes only)
183*f412fefaSKyungmin Park  * @upd_marker: %1 if the update marker is set for this volume
184*f412fefaSKyungmin Park  * @updating: %1 if the volume is being updated
185*f412fefaSKyungmin Park  * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
186*f412fefaSKyungmin Park  *
187*f412fefaSKyungmin Park  * @gluebi_desc: gluebi UBI volume descriptor
188*f412fefaSKyungmin Park  * @gluebi_refcount: reference count of the gluebi MTD device
189*f412fefaSKyungmin Park  * @gluebi_mtd: MTD device description object of the gluebi MTD device
190*f412fefaSKyungmin Park  *
191*f412fefaSKyungmin Park  * The @corrupted field indicates that the volume's contents is corrupted.
192*f412fefaSKyungmin Park  * Since UBI protects only static volumes, this field is not relevant to
193*f412fefaSKyungmin Park  * dynamic volumes - it is user's responsibility to assure their data
194*f412fefaSKyungmin Park  * integrity.
195*f412fefaSKyungmin Park  *
196*f412fefaSKyungmin Park  * The @upd_marker flag indicates that this volume is either being updated at
197*f412fefaSKyungmin Park  * the moment or is damaged because of an unclean reboot.
198*f412fefaSKyungmin Park  */
199*f412fefaSKyungmin Park struct ubi_volume {
200*f412fefaSKyungmin Park 	struct device dev;
201*f412fefaSKyungmin Park 	struct cdev cdev;
202*f412fefaSKyungmin Park 	struct ubi_device *ubi;
203*f412fefaSKyungmin Park 	int vol_id;
204*f412fefaSKyungmin Park 	int ref_count;
205*f412fefaSKyungmin Park 	int readers;
206*f412fefaSKyungmin Park 	int writers;
207*f412fefaSKyungmin Park 	int exclusive;
208*f412fefaSKyungmin Park 
209*f412fefaSKyungmin Park 	int reserved_pebs;
210*f412fefaSKyungmin Park 	int vol_type;
211*f412fefaSKyungmin Park 	int usable_leb_size;
212*f412fefaSKyungmin Park 	int used_ebs;
213*f412fefaSKyungmin Park 	int last_eb_bytes;
214*f412fefaSKyungmin Park 	long long used_bytes;
215*f412fefaSKyungmin Park 	int alignment;
216*f412fefaSKyungmin Park 	int data_pad;
217*f412fefaSKyungmin Park 	int name_len;
218*f412fefaSKyungmin Park 	char name[UBI_VOL_NAME_MAX+1];
219*f412fefaSKyungmin Park 
220*f412fefaSKyungmin Park 	int upd_ebs;
221*f412fefaSKyungmin Park 	int ch_lnum;
222*f412fefaSKyungmin Park 	int ch_dtype;
223*f412fefaSKyungmin Park 	long long upd_bytes;
224*f412fefaSKyungmin Park 	long long upd_received;
225*f412fefaSKyungmin Park 	void *upd_buf;
226*f412fefaSKyungmin Park 
227*f412fefaSKyungmin Park 	int *eba_tbl;
228*f412fefaSKyungmin Park 	unsigned int checked:1;
229*f412fefaSKyungmin Park 	unsigned int corrupted:1;
230*f412fefaSKyungmin Park 	unsigned int upd_marker:1;
231*f412fefaSKyungmin Park 	unsigned int updating:1;
232*f412fefaSKyungmin Park 	unsigned int changing_leb:1;
233*f412fefaSKyungmin Park 
234*f412fefaSKyungmin Park #ifdef CONFIG_MTD_UBI_GLUEBI
235*f412fefaSKyungmin Park 	/*
236*f412fefaSKyungmin Park 	 * Gluebi-related stuff may be compiled out.
237*f412fefaSKyungmin Park 	 * TODO: this should not be built into UBI but should be a separate
238*f412fefaSKyungmin Park 	 * ubimtd driver which works on top of UBI and emulates MTD devices.
239*f412fefaSKyungmin Park 	 */
240*f412fefaSKyungmin Park 	struct ubi_volume_desc *gluebi_desc;
241*f412fefaSKyungmin Park 	int gluebi_refcount;
242*f412fefaSKyungmin Park 	struct mtd_info gluebi_mtd;
243*f412fefaSKyungmin Park #endif
244*f412fefaSKyungmin Park };
245*f412fefaSKyungmin Park 
246*f412fefaSKyungmin Park /**
247*f412fefaSKyungmin Park  * struct ubi_volume_desc - descriptor of the UBI volume returned when it is
248*f412fefaSKyungmin Park  * opened.
249*f412fefaSKyungmin Park  * @vol: reference to the corresponding volume description object
250*f412fefaSKyungmin Park  * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, or %UBI_EXCLUSIVE)
251*f412fefaSKyungmin Park  */
252*f412fefaSKyungmin Park struct ubi_volume_desc {
253*f412fefaSKyungmin Park 	struct ubi_volume *vol;
254*f412fefaSKyungmin Park 	int mode;
255*f412fefaSKyungmin Park };
256*f412fefaSKyungmin Park 
257*f412fefaSKyungmin Park struct ubi_wl_entry;
258*f412fefaSKyungmin Park 
259*f412fefaSKyungmin Park /**
260*f412fefaSKyungmin Park  * struct ubi_device - UBI device description structure
261*f412fefaSKyungmin Park  * @dev: UBI device object to use the the Linux device model
262*f412fefaSKyungmin Park  * @cdev: character device object to create character device
263*f412fefaSKyungmin Park  * @ubi_num: UBI device number
264*f412fefaSKyungmin Park  * @ubi_name: UBI device name
265*f412fefaSKyungmin Park  * @vol_count: number of volumes in this UBI device
266*f412fefaSKyungmin Park  * @volumes: volumes of this UBI device
267*f412fefaSKyungmin Park  * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
268*f412fefaSKyungmin Park  *                @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
269*f412fefaSKyungmin Park  *                @vol->readers, @vol->writers, @vol->exclusive,
270*f412fefaSKyungmin Park  *                @vol->ref_count, @vol->mapping and @vol->eba_tbl.
271*f412fefaSKyungmin Park  * @ref_count: count of references on the UBI device
272*f412fefaSKyungmin Park  *
273*f412fefaSKyungmin Park  * @rsvd_pebs: count of reserved physical eraseblocks
274*f412fefaSKyungmin Park  * @avail_pebs: count of available physical eraseblocks
275*f412fefaSKyungmin Park  * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
276*f412fefaSKyungmin Park  *                 handling
277*f412fefaSKyungmin Park  * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
278*f412fefaSKyungmin Park  *
279*f412fefaSKyungmin Park  * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
280*f412fefaSKyungmin Park  *                     of UBI ititializetion
281*f412fefaSKyungmin Park  * @vtbl_slots: how many slots are available in the volume table
282*f412fefaSKyungmin Park  * @vtbl_size: size of the volume table in bytes
283*f412fefaSKyungmin Park  * @vtbl: in-RAM volume table copy
284*f412fefaSKyungmin Park  * @volumes_mutex: protects on-flash volume table and serializes volume
285*f412fefaSKyungmin Park  *                 changes, like creation, deletion, update, resize
286*f412fefaSKyungmin Park  *
287*f412fefaSKyungmin Park  * @max_ec: current highest erase counter value
288*f412fefaSKyungmin Park  * @mean_ec: current mean erase counter value
289*f412fefaSKyungmin Park  *
290*f412fefaSKyungmin Park  * @global_sqnum: global sequence number
291*f412fefaSKyungmin Park  * @ltree_lock: protects the lock tree and @global_sqnum
292*f412fefaSKyungmin Park  * @ltree: the lock tree
293*f412fefaSKyungmin Park  * @alc_mutex: serializes "atomic LEB change" operations
294*f412fefaSKyungmin Park  *
295*f412fefaSKyungmin Park  * @used: RB-tree of used physical eraseblocks
296*f412fefaSKyungmin Park  * @free: RB-tree of free physical eraseblocks
297*f412fefaSKyungmin Park  * @scrub: RB-tree of physical eraseblocks which need scrubbing
298*f412fefaSKyungmin Park  * @prot: protection trees
299*f412fefaSKyungmin Park  * @prot.pnum: protection tree indexed by physical eraseblock numbers
300*f412fefaSKyungmin Park  * @prot.aec: protection tree indexed by absolute erase counter value
301*f412fefaSKyungmin Park  * @wl_lock: protects the @used, @free, @prot, @lookuptbl, @abs_ec, @move_from,
302*f412fefaSKyungmin Park  *           @move_to, @move_to_put @erase_pending, @wl_scheduled, and @works
303*f412fefaSKyungmin Park  *           fields
304*f412fefaSKyungmin Park  * @move_mutex: serializes eraseblock moves
305*f412fefaSKyungmin Park  * @wl_scheduled: non-zero if the wear-leveling was scheduled
306*f412fefaSKyungmin Park  * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
307*f412fefaSKyungmin Park  *             physical eraseblock
308*f412fefaSKyungmin Park  * @abs_ec: absolute erase counter
309*f412fefaSKyungmin Park  * @move_from: physical eraseblock from where the data is being moved
310*f412fefaSKyungmin Park  * @move_to: physical eraseblock where the data is being moved to
311*f412fefaSKyungmin Park  * @move_to_put: if the "to" PEB was put
312*f412fefaSKyungmin Park  * @works: list of pending works
313*f412fefaSKyungmin Park  * @works_count: count of pending works
314*f412fefaSKyungmin Park  * @bgt_thread: background thread description object
315*f412fefaSKyungmin Park  * @thread_enabled: if the background thread is enabled
316*f412fefaSKyungmin Park  * @bgt_name: background thread name
317*f412fefaSKyungmin Park  *
318*f412fefaSKyungmin Park  * @flash_size: underlying MTD device size (in bytes)
319*f412fefaSKyungmin Park  * @peb_count: count of physical eraseblocks on the MTD device
320*f412fefaSKyungmin Park  * @peb_size: physical eraseblock size
321*f412fefaSKyungmin Park  * @bad_peb_count: count of bad physical eraseblocks
322*f412fefaSKyungmin Park  * @good_peb_count: count of good physical eraseblocks
323*f412fefaSKyungmin Park  * @min_io_size: minimal input/output unit size of the underlying MTD device
324*f412fefaSKyungmin Park  * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
325*f412fefaSKyungmin Park  * @ro_mode: if the UBI device is in read-only mode
326*f412fefaSKyungmin Park  * @leb_size: logical eraseblock size
327*f412fefaSKyungmin Park  * @leb_start: starting offset of logical eraseblocks within physical
328*f412fefaSKyungmin Park  * eraseblocks
329*f412fefaSKyungmin Park  * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
330*f412fefaSKyungmin Park  * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
331*f412fefaSKyungmin Park  * @vid_hdr_offset: starting offset of the volume identifier header (might be
332*f412fefaSKyungmin Park  * unaligned)
333*f412fefaSKyungmin Park  * @vid_hdr_aloffset: starting offset of the VID header aligned to
334*f412fefaSKyungmin Park  * @hdrs_min_io_size
335*f412fefaSKyungmin Park  * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
336*f412fefaSKyungmin Park  * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
337*f412fefaSKyungmin Park  *               not
338*f412fefaSKyungmin Park  * @mtd: MTD device descriptor
339*f412fefaSKyungmin Park  *
340*f412fefaSKyungmin Park  * @peb_buf1: a buffer of PEB size used for different purposes
341*f412fefaSKyungmin Park  * @peb_buf2: another buffer of PEB size used for different purposes
342*f412fefaSKyungmin Park  * @buf_mutex: proptects @peb_buf1 and @peb_buf2
343*f412fefaSKyungmin Park  * @dbg_peb_buf: buffer of PEB size used for debugging
344*f412fefaSKyungmin Park  * @dbg_buf_mutex: proptects @dbg_peb_buf
345*f412fefaSKyungmin Park  */
346*f412fefaSKyungmin Park struct ubi_device {
347*f412fefaSKyungmin Park 	struct cdev cdev;
348*f412fefaSKyungmin Park 	struct device dev;
349*f412fefaSKyungmin Park 	int ubi_num;
350*f412fefaSKyungmin Park 	char ubi_name[sizeof(UBI_NAME_STR)+5];
351*f412fefaSKyungmin Park 	int vol_count;
352*f412fefaSKyungmin Park 	struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
353*f412fefaSKyungmin Park 	spinlock_t volumes_lock;
354*f412fefaSKyungmin Park 	int ref_count;
355*f412fefaSKyungmin Park 
356*f412fefaSKyungmin Park 	int rsvd_pebs;
357*f412fefaSKyungmin Park 	int avail_pebs;
358*f412fefaSKyungmin Park 	int beb_rsvd_pebs;
359*f412fefaSKyungmin Park 	int beb_rsvd_level;
360*f412fefaSKyungmin Park 
361*f412fefaSKyungmin Park 	int autoresize_vol_id;
362*f412fefaSKyungmin Park 	int vtbl_slots;
363*f412fefaSKyungmin Park 	int vtbl_size;
364*f412fefaSKyungmin Park 	struct ubi_vtbl_record *vtbl;
365*f412fefaSKyungmin Park 	struct mutex volumes_mutex;
366*f412fefaSKyungmin Park 
367*f412fefaSKyungmin Park 	int max_ec;
368*f412fefaSKyungmin Park 	/* TODO: mean_ec is not updated run-time, fix */
369*f412fefaSKyungmin Park 	int mean_ec;
370*f412fefaSKyungmin Park 
371*f412fefaSKyungmin Park 	/* EBA unit's stuff */
372*f412fefaSKyungmin Park 	unsigned long long global_sqnum;
373*f412fefaSKyungmin Park 	spinlock_t ltree_lock;
374*f412fefaSKyungmin Park 	struct rb_root ltree;
375*f412fefaSKyungmin Park 	struct mutex alc_mutex;
376*f412fefaSKyungmin Park 
377*f412fefaSKyungmin Park 	/* Wear-leveling unit's stuff */
378*f412fefaSKyungmin Park 	struct rb_root used;
379*f412fefaSKyungmin Park 	struct rb_root free;
380*f412fefaSKyungmin Park 	struct rb_root scrub;
381*f412fefaSKyungmin Park 	struct {
382*f412fefaSKyungmin Park 		struct rb_root pnum;
383*f412fefaSKyungmin Park 		struct rb_root aec;
384*f412fefaSKyungmin Park 	} prot;
385*f412fefaSKyungmin Park 	spinlock_t wl_lock;
386*f412fefaSKyungmin Park 	struct mutex move_mutex;
387*f412fefaSKyungmin Park 	struct rw_semaphore work_sem;
388*f412fefaSKyungmin Park 	int wl_scheduled;
389*f412fefaSKyungmin Park 	struct ubi_wl_entry **lookuptbl;
390*f412fefaSKyungmin Park 	unsigned long long abs_ec;
391*f412fefaSKyungmin Park 	struct ubi_wl_entry *move_from;
392*f412fefaSKyungmin Park 	struct ubi_wl_entry *move_to;
393*f412fefaSKyungmin Park 	int move_to_put;
394*f412fefaSKyungmin Park 	struct list_head works;
395*f412fefaSKyungmin Park 	int works_count;
396*f412fefaSKyungmin Park 	struct task_struct *bgt_thread;
397*f412fefaSKyungmin Park 	int thread_enabled;
398*f412fefaSKyungmin Park 	char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
399*f412fefaSKyungmin Park 
400*f412fefaSKyungmin Park 	/* I/O unit's stuff */
401*f412fefaSKyungmin Park 	long long flash_size;
402*f412fefaSKyungmin Park 	int peb_count;
403*f412fefaSKyungmin Park 	int peb_size;
404*f412fefaSKyungmin Park 	int bad_peb_count;
405*f412fefaSKyungmin Park 	int good_peb_count;
406*f412fefaSKyungmin Park 	int min_io_size;
407*f412fefaSKyungmin Park 	int hdrs_min_io_size;
408*f412fefaSKyungmin Park 	int ro_mode;
409*f412fefaSKyungmin Park 	int leb_size;
410*f412fefaSKyungmin Park 	int leb_start;
411*f412fefaSKyungmin Park 	int ec_hdr_alsize;
412*f412fefaSKyungmin Park 	int vid_hdr_alsize;
413*f412fefaSKyungmin Park 	int vid_hdr_offset;
414*f412fefaSKyungmin Park 	int vid_hdr_aloffset;
415*f412fefaSKyungmin Park 	int vid_hdr_shift;
416*f412fefaSKyungmin Park 	int bad_allowed;
417*f412fefaSKyungmin Park 	struct mtd_info *mtd;
418*f412fefaSKyungmin Park 
419*f412fefaSKyungmin Park 	void *peb_buf1;
420*f412fefaSKyungmin Park 	void *peb_buf2;
421*f412fefaSKyungmin Park 	struct mutex buf_mutex;
422*f412fefaSKyungmin Park 	struct mutex ckvol_mutex;
423*f412fefaSKyungmin Park #ifdef CONFIG_MTD_UBI_DEBUG
424*f412fefaSKyungmin Park 	void *dbg_peb_buf;
425*f412fefaSKyungmin Park 	struct mutex dbg_buf_mutex;
426*f412fefaSKyungmin Park #endif
427*f412fefaSKyungmin Park };
428*f412fefaSKyungmin Park 
429*f412fefaSKyungmin Park extern struct kmem_cache *ubi_wl_entry_slab;
430*f412fefaSKyungmin Park extern struct file_operations ubi_ctrl_cdev_operations;
431*f412fefaSKyungmin Park extern struct file_operations ubi_cdev_operations;
432*f412fefaSKyungmin Park extern struct file_operations ubi_vol_cdev_operations;
433*f412fefaSKyungmin Park extern struct class *ubi_class;
434*f412fefaSKyungmin Park extern struct mutex ubi_devices_mutex;
435*f412fefaSKyungmin Park 
436*f412fefaSKyungmin Park /* vtbl.c */
437*f412fefaSKyungmin Park int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
438*f412fefaSKyungmin Park 			   struct ubi_vtbl_record *vtbl_rec);
439*f412fefaSKyungmin Park int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_scan_info *si);
440*f412fefaSKyungmin Park 
441*f412fefaSKyungmin Park /* vmt.c */
442*f412fefaSKyungmin Park int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
443*f412fefaSKyungmin Park int ubi_remove_volume(struct ubi_volume_desc *desc);
444*f412fefaSKyungmin Park int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
445*f412fefaSKyungmin Park int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
446*f412fefaSKyungmin Park void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
447*f412fefaSKyungmin Park 
448*f412fefaSKyungmin Park /* upd.c */
449*f412fefaSKyungmin Park int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
450*f412fefaSKyungmin Park 		     long long bytes);
451*f412fefaSKyungmin Park int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
452*f412fefaSKyungmin Park 			 const void __user *buf, int count);
453*f412fefaSKyungmin Park int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
454*f412fefaSKyungmin Park 			 const struct ubi_leb_change_req *req);
455*f412fefaSKyungmin Park int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
456*f412fefaSKyungmin Park 			     const void __user *buf, int count);
457*f412fefaSKyungmin Park 
458*f412fefaSKyungmin Park /* misc.c */
459*f412fefaSKyungmin Park int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf, int length);
460*f412fefaSKyungmin Park int ubi_check_volume(struct ubi_device *ubi, int vol_id);
461*f412fefaSKyungmin Park void ubi_calculate_reserved(struct ubi_device *ubi);
462*f412fefaSKyungmin Park 
463*f412fefaSKyungmin Park /* gluebi.c */
464*f412fefaSKyungmin Park #ifdef CONFIG_MTD_UBI_GLUEBI
465*f412fefaSKyungmin Park int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol);
466*f412fefaSKyungmin Park int ubi_destroy_gluebi(struct ubi_volume *vol);
467*f412fefaSKyungmin Park void ubi_gluebi_updated(struct ubi_volume *vol);
468*f412fefaSKyungmin Park #else
469*f412fefaSKyungmin Park #define ubi_create_gluebi(ubi, vol) 0
470*f412fefaSKyungmin Park #define ubi_destroy_gluebi(vol) 0
471*f412fefaSKyungmin Park #define ubi_gluebi_updated(vol)
472*f412fefaSKyungmin Park #endif
473*f412fefaSKyungmin Park 
474*f412fefaSKyungmin Park /* eba.c */
475*f412fefaSKyungmin Park int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
476*f412fefaSKyungmin Park 		      int lnum);
477*f412fefaSKyungmin Park int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
478*f412fefaSKyungmin Park 		     void *buf, int offset, int len, int check);
479*f412fefaSKyungmin Park int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
480*f412fefaSKyungmin Park 		      const void *buf, int offset, int len, int dtype);
481*f412fefaSKyungmin Park int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
482*f412fefaSKyungmin Park 			 int lnum, const void *buf, int len, int dtype,
483*f412fefaSKyungmin Park 			 int used_ebs);
484*f412fefaSKyungmin Park int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
485*f412fefaSKyungmin Park 			      int lnum, const void *buf, int len, int dtype);
486*f412fefaSKyungmin Park int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
487*f412fefaSKyungmin Park 		     struct ubi_vid_hdr *vid_hdr);
488*f412fefaSKyungmin Park int ubi_eba_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
489*f412fefaSKyungmin Park void ubi_eba_close(const struct ubi_device *ubi);
490*f412fefaSKyungmin Park 
491*f412fefaSKyungmin Park /* wl.c */
492*f412fefaSKyungmin Park int ubi_wl_get_peb(struct ubi_device *ubi, int dtype);
493*f412fefaSKyungmin Park int ubi_wl_put_peb(struct ubi_device *ubi, int pnum, int torture);
494*f412fefaSKyungmin Park int ubi_wl_flush(struct ubi_device *ubi);
495*f412fefaSKyungmin Park int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
496*f412fefaSKyungmin Park int ubi_wl_init_scan(struct ubi_device *ubi, struct ubi_scan_info *si);
497*f412fefaSKyungmin Park void ubi_wl_close(struct ubi_device *ubi);
498*f412fefaSKyungmin Park int ubi_thread(void *u);
499*f412fefaSKyungmin Park 
500*f412fefaSKyungmin Park /* io.c */
501*f412fefaSKyungmin Park int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
502*f412fefaSKyungmin Park 		int len);
503*f412fefaSKyungmin Park int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
504*f412fefaSKyungmin Park 		 int len);
505*f412fefaSKyungmin Park int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
506*f412fefaSKyungmin Park int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
507*f412fefaSKyungmin Park int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
508*f412fefaSKyungmin Park int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
509*f412fefaSKyungmin Park 		       struct ubi_ec_hdr *ec_hdr, int verbose);
510*f412fefaSKyungmin Park int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
511*f412fefaSKyungmin Park 			struct ubi_ec_hdr *ec_hdr);
512*f412fefaSKyungmin Park int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
513*f412fefaSKyungmin Park 			struct ubi_vid_hdr *vid_hdr, int verbose);
514*f412fefaSKyungmin Park int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
515*f412fefaSKyungmin Park 			 struct ubi_vid_hdr *vid_hdr);
516*f412fefaSKyungmin Park 
517*f412fefaSKyungmin Park /* build.c */
518*f412fefaSKyungmin Park int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset);
519*f412fefaSKyungmin Park int ubi_detach_mtd_dev(int ubi_num, int anyway);
520*f412fefaSKyungmin Park struct ubi_device *ubi_get_device(int ubi_num);
521*f412fefaSKyungmin Park void ubi_put_device(struct ubi_device *ubi);
522*f412fefaSKyungmin Park struct ubi_device *ubi_get_by_major(int major);
523*f412fefaSKyungmin Park int ubi_major2num(int major);
524*f412fefaSKyungmin Park 
525*f412fefaSKyungmin Park /*
526*f412fefaSKyungmin Park  * ubi_rb_for_each_entry - walk an RB-tree.
527*f412fefaSKyungmin Park  * @rb: a pointer to type 'struct rb_node' to to use as a loop counter
528*f412fefaSKyungmin Park  * @pos: a pointer to RB-tree entry type to use as a loop counter
529*f412fefaSKyungmin Park  * @root: RB-tree's root
530*f412fefaSKyungmin Park  * @member: the name of the 'struct rb_node' within the RB-tree entry
531*f412fefaSKyungmin Park  */
532*f412fefaSKyungmin Park #define ubi_rb_for_each_entry(rb, pos, root, member)                         \
533*f412fefaSKyungmin Park 	for (rb = rb_first(root),                                            \
534*f412fefaSKyungmin Park 	     pos = (rb ? container_of(rb, typeof(*pos), member) : NULL);     \
535*f412fefaSKyungmin Park 	     rb;                                                             \
536*f412fefaSKyungmin Park 	     rb = rb_next(rb), pos = container_of(rb, typeof(*pos), member))
537*f412fefaSKyungmin Park 
538*f412fefaSKyungmin Park /**
539*f412fefaSKyungmin Park  * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
540*f412fefaSKyungmin Park  * @ubi: UBI device description object
541*f412fefaSKyungmin Park  * @gfp_flags: GFP flags to allocate with
542*f412fefaSKyungmin Park  *
543*f412fefaSKyungmin Park  * This function returns a pointer to the newly allocated and zero-filled
544*f412fefaSKyungmin Park  * volume identifier header object in case of success and %NULL in case of
545*f412fefaSKyungmin Park  * failure.
546*f412fefaSKyungmin Park  */
547*f412fefaSKyungmin Park static inline struct ubi_vid_hdr *
548*f412fefaSKyungmin Park ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
549*f412fefaSKyungmin Park {
550*f412fefaSKyungmin Park 	void *vid_hdr;
551*f412fefaSKyungmin Park 
552*f412fefaSKyungmin Park 	vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
553*f412fefaSKyungmin Park 	if (!vid_hdr)
554*f412fefaSKyungmin Park 		return NULL;
555*f412fefaSKyungmin Park 
556*f412fefaSKyungmin Park 	/*
557*f412fefaSKyungmin Park 	 * VID headers may be stored at un-aligned flash offsets, so we shift
558*f412fefaSKyungmin Park 	 * the pointer.
559*f412fefaSKyungmin Park 	 */
560*f412fefaSKyungmin Park 	return vid_hdr + ubi->vid_hdr_shift;
561*f412fefaSKyungmin Park }
562*f412fefaSKyungmin Park 
563*f412fefaSKyungmin Park /**
564*f412fefaSKyungmin Park  * ubi_free_vid_hdr - free a volume identifier header object.
565*f412fefaSKyungmin Park  * @ubi: UBI device description object
566*f412fefaSKyungmin Park  * @vid_hdr: the object to free
567*f412fefaSKyungmin Park  */
568*f412fefaSKyungmin Park static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
569*f412fefaSKyungmin Park 				    struct ubi_vid_hdr *vid_hdr)
570*f412fefaSKyungmin Park {
571*f412fefaSKyungmin Park 	void *p = vid_hdr;
572*f412fefaSKyungmin Park 
573*f412fefaSKyungmin Park 	if (!p)
574*f412fefaSKyungmin Park 		return;
575*f412fefaSKyungmin Park 
576*f412fefaSKyungmin Park 	kfree(p - ubi->vid_hdr_shift);
577*f412fefaSKyungmin Park }
578*f412fefaSKyungmin Park 
579*f412fefaSKyungmin Park /*
580*f412fefaSKyungmin Park  * This function is equivalent to 'ubi_io_read()', but @offset is relative to
581*f412fefaSKyungmin Park  * the beginning of the logical eraseblock, not to the beginning of the
582*f412fefaSKyungmin Park  * physical eraseblock.
583*f412fefaSKyungmin Park  */
584*f412fefaSKyungmin Park static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
585*f412fefaSKyungmin Park 				   int pnum, int offset, int len)
586*f412fefaSKyungmin Park {
587*f412fefaSKyungmin Park 	ubi_assert(offset >= 0);
588*f412fefaSKyungmin Park 	return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
589*f412fefaSKyungmin Park }
590*f412fefaSKyungmin Park 
591*f412fefaSKyungmin Park /*
592*f412fefaSKyungmin Park  * This function is equivalent to 'ubi_io_write()', but @offset is relative to
593*f412fefaSKyungmin Park  * the beginning of the logical eraseblock, not to the beginning of the
594*f412fefaSKyungmin Park  * physical eraseblock.
595*f412fefaSKyungmin Park  */
596*f412fefaSKyungmin Park static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
597*f412fefaSKyungmin Park 				    int pnum, int offset, int len)
598*f412fefaSKyungmin Park {
599*f412fefaSKyungmin Park 	ubi_assert(offset >= 0);
600*f412fefaSKyungmin Park 	return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
601*f412fefaSKyungmin Park }
602*f412fefaSKyungmin Park 
603*f412fefaSKyungmin Park /**
604*f412fefaSKyungmin Park  * ubi_ro_mode - switch to read-only mode.
605*f412fefaSKyungmin Park  * @ubi: UBI device description object
606*f412fefaSKyungmin Park  */
607*f412fefaSKyungmin Park static inline void ubi_ro_mode(struct ubi_device *ubi)
608*f412fefaSKyungmin Park {
609*f412fefaSKyungmin Park 	if (!ubi->ro_mode) {
610*f412fefaSKyungmin Park 		ubi->ro_mode = 1;
611*f412fefaSKyungmin Park 		ubi_warn("switch to read-only mode");
612*f412fefaSKyungmin Park 	}
613*f412fefaSKyungmin Park }
614*f412fefaSKyungmin Park 
615*f412fefaSKyungmin Park /**
616*f412fefaSKyungmin Park  * vol_id2idx - get table index by volume ID.
617*f412fefaSKyungmin Park  * @ubi: UBI device description object
618*f412fefaSKyungmin Park  * @vol_id: volume ID
619*f412fefaSKyungmin Park  */
620*f412fefaSKyungmin Park static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
621*f412fefaSKyungmin Park {
622*f412fefaSKyungmin Park 	if (vol_id >= UBI_INTERNAL_VOL_START)
623*f412fefaSKyungmin Park 		return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
624*f412fefaSKyungmin Park 	else
625*f412fefaSKyungmin Park 		return vol_id;
626*f412fefaSKyungmin Park }
627*f412fefaSKyungmin Park 
628*f412fefaSKyungmin Park /**
629*f412fefaSKyungmin Park  * idx2vol_id - get volume ID by table index.
630*f412fefaSKyungmin Park  * @ubi: UBI device description object
631*f412fefaSKyungmin Park  * @idx: table index
632*f412fefaSKyungmin Park  */
633*f412fefaSKyungmin Park static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
634*f412fefaSKyungmin Park {
635*f412fefaSKyungmin Park 	if (idx >= ubi->vtbl_slots)
636*f412fefaSKyungmin Park 		return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
637*f412fefaSKyungmin Park 	else
638*f412fefaSKyungmin Park 		return idx;
639*f412fefaSKyungmin Park }
640*f412fefaSKyungmin Park 
641*f412fefaSKyungmin Park #endif /* !__UBI_UBI_H__ */
642