ubi.h 21 KB

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