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