ubi.h 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (c) International Business Machines Corp., 2006
  4. * Copyright (c) Nokia Corporation, 2006, 2007
  5. *
  6. * Author: Artem Bityutskiy (Битюцкий Артём)
  7. */
  8. #ifndef __UBI_UBI_H__
  9. #define __UBI_UBI_H__
  10. #ifndef __UBOOT__
  11. #include <linux/types.h>
  12. #include <linux/list.h>
  13. #include <linux/rbtree.h>
  14. #include <linux/sched.h>
  15. #include <linux/wait.h>
  16. #include <linux/mutex.h>
  17. #include <linux/rwsem.h>
  18. #include <linux/spinlock.h>
  19. #include <linux/fs.h>
  20. #include <linux/cdev.h>
  21. #include <linux/device.h>
  22. #include <linux/slab.h>
  23. #include <linux/string.h>
  24. #include <linux/vmalloc.h>
  25. #include <linux/notifier.h>
  26. #include <asm/pgtable.h>
  27. #else
  28. #include <ubi_uboot.h>
  29. #endif
  30. #include <linux/mtd/mtd.h>
  31. #include <linux/mtd/ubi.h>
  32. #include "ubi-media.h"
  33. #include <mtd/ubi-user.h>
  34. /* Maximum number of supported UBI devices */
  35. #define UBI_MAX_DEVICES 32
  36. /* UBI name used for character devices, sysfs, etc */
  37. #define UBI_NAME_STR "ubi"
  38. /* Normal UBI messages */
  39. #ifdef CONFIG_UBI_SILENCE_MSG
  40. #define ubi_msg(ubi, fmt, ...)
  41. #else
  42. #define ubi_msg(ubi, fmt, ...) printk(UBI_NAME_STR "%d: " fmt "\n", \
  43. ubi->ubi_num, ##__VA_ARGS__)
  44. #endif
  45. /* UBI warning messages */
  46. #define ubi_warn(ubi, fmt, ...) pr_warn(UBI_NAME_STR "%d warning: %s: " fmt "\n", \
  47. ubi->ubi_num, __func__, ##__VA_ARGS__)
  48. /* UBI error messages */
  49. #define ubi_err(ubi, fmt, ...) pr_err(UBI_NAME_STR "%d error: %s: " fmt "\n", \
  50. ubi->ubi_num, __func__, ##__VA_ARGS__)
  51. /* Background thread name pattern */
  52. #define UBI_BGT_NAME_PATTERN "ubi_bgt%dd"
  53. /*
  54. * This marker in the EBA table means that the LEB is um-mapped.
  55. * NOTE! It has to have the same value as %UBI_ALL.
  56. */
  57. #define UBI_LEB_UNMAPPED -1
  58. /*
  59. * In case of errors, UBI tries to repeat the operation several times before
  60. * returning error. The below constant defines how many times UBI re-tries.
  61. */
  62. #define UBI_IO_RETRIES 3
  63. /*
  64. * Length of the protection queue. The length is effectively equivalent to the
  65. * number of (global) erase cycles PEBs are protected from the wear-leveling
  66. * worker.
  67. */
  68. #define UBI_PROT_QUEUE_LEN 10
  69. /* The volume ID/LEB number/erase counter is unknown */
  70. #define UBI_UNKNOWN -1
  71. /*
  72. * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
  73. * + 2 for the number plus 1 for the trailing zero byte.
  74. */
  75. #define UBI_DFS_DIR_NAME "ubi%d"
  76. #define UBI_DFS_DIR_LEN (3 + 2 + 1)
  77. /*
  78. * Error codes returned by the I/O sub-system.
  79. *
  80. * UBI_IO_FF: the read region of flash contains only 0xFFs
  81. * UBI_IO_FF_BITFLIPS: the same as %UBI_IO_FF, but also also there was a data
  82. * integrity error reported by the MTD driver
  83. * (uncorrectable ECC error in case of NAND)
  84. * UBI_IO_BAD_HDR: the EC or VID header is corrupted (bad magic or CRC)
  85. * UBI_IO_BAD_HDR_EBADMSG: the same as %UBI_IO_BAD_HDR, but also there was a
  86. * data integrity error reported by the MTD driver
  87. * (uncorrectable ECC error in case of NAND)
  88. * UBI_IO_BITFLIPS: bit-flips were detected and corrected
  89. *
  90. * Note, it is probably better to have bit-flip and ebadmsg as flags which can
  91. * be or'ed with other error code. But this is a big change because there are
  92. * may callers, so it does not worth the risk of introducing a bug
  93. */
  94. enum {
  95. UBI_IO_FF = 1,
  96. UBI_IO_FF_BITFLIPS,
  97. UBI_IO_BAD_HDR,
  98. UBI_IO_BAD_HDR_EBADMSG,
  99. UBI_IO_BITFLIPS,
  100. };
  101. /*
  102. * Return codes of the 'ubi_eba_copy_leb()' function.
  103. *
  104. * MOVE_CANCEL_RACE: canceled because the volume is being deleted, the source
  105. * PEB was put meanwhile, or there is I/O on the source PEB
  106. * MOVE_SOURCE_RD_ERR: canceled because there was a read error from the source
  107. * PEB
  108. * MOVE_TARGET_RD_ERR: canceled because there was a read error from the target
  109. * PEB
  110. * MOVE_TARGET_WR_ERR: canceled because there was a write error to the target
  111. * PEB
  112. * MOVE_TARGET_BITFLIPS: canceled because a bit-flip was detected in the
  113. * target PEB
  114. * MOVE_RETRY: retry scrubbing the PEB
  115. */
  116. enum {
  117. MOVE_CANCEL_RACE = 1,
  118. MOVE_SOURCE_RD_ERR,
  119. MOVE_TARGET_RD_ERR,
  120. MOVE_TARGET_WR_ERR,
  121. MOVE_TARGET_BITFLIPS,
  122. MOVE_RETRY,
  123. };
  124. /*
  125. * Return codes of the fastmap sub-system
  126. *
  127. * UBI_NO_FASTMAP: No fastmap super block was found
  128. * UBI_BAD_FASTMAP: A fastmap was found but it's unusable
  129. */
  130. enum {
  131. UBI_NO_FASTMAP = 1,
  132. UBI_BAD_FASTMAP,
  133. };
  134. /*
  135. * Flags for emulate_power_cut in ubi_debug_info
  136. *
  137. * POWER_CUT_EC_WRITE: Emulate a power cut when writing an EC header
  138. * POWER_CUT_VID_WRITE: Emulate a power cut when writing a VID header
  139. */
  140. enum {
  141. POWER_CUT_EC_WRITE = 0x01,
  142. POWER_CUT_VID_WRITE = 0x02,
  143. };
  144. /**
  145. * struct ubi_wl_entry - wear-leveling entry.
  146. * @u.rb: link in the corresponding (free/used) RB-tree
  147. * @u.list: link in the protection queue
  148. * @ec: erase counter
  149. * @pnum: physical eraseblock number
  150. *
  151. * This data structure is used in the WL sub-system. Each physical eraseblock
  152. * has a corresponding &struct wl_entry object which may be kept in different
  153. * RB-trees. See WL sub-system for details.
  154. */
  155. struct ubi_wl_entry {
  156. union {
  157. struct rb_node rb;
  158. struct list_head list;
  159. } u;
  160. int ec;
  161. int pnum;
  162. };
  163. /**
  164. * struct ubi_ltree_entry - an entry in the lock tree.
  165. * @rb: links RB-tree nodes
  166. * @vol_id: volume ID of the locked logical eraseblock
  167. * @lnum: locked logical eraseblock number
  168. * @users: how many tasks are using this logical eraseblock or wait for it
  169. * @mutex: read/write mutex to implement read/write access serialization to
  170. * the (@vol_id, @lnum) logical eraseblock
  171. *
  172. * This data structure is used in the EBA sub-system to implement per-LEB
  173. * locking. When a logical eraseblock is being locked - corresponding
  174. * &struct ubi_ltree_entry object is inserted to the lock tree (@ubi->ltree).
  175. * See EBA sub-system for details.
  176. */
  177. struct ubi_ltree_entry {
  178. struct rb_node rb;
  179. int vol_id;
  180. int lnum;
  181. int users;
  182. struct rw_semaphore mutex;
  183. };
  184. /**
  185. * struct ubi_rename_entry - volume re-name description data structure.
  186. * @new_name_len: new volume name length
  187. * @new_name: new volume name
  188. * @remove: if not zero, this volume should be removed, not re-named
  189. * @desc: descriptor of the volume
  190. * @list: links re-name entries into a list
  191. *
  192. * This data structure is utilized in the multiple volume re-name code. Namely,
  193. * UBI first creates a list of &struct ubi_rename_entry objects from the
  194. * &struct ubi_rnvol_req request object, and then utilizes this list to do all
  195. * the job.
  196. */
  197. struct ubi_rename_entry {
  198. int new_name_len;
  199. char new_name[UBI_VOL_NAME_MAX + 1];
  200. int remove;
  201. struct ubi_volume_desc *desc;
  202. struct list_head list;
  203. };
  204. struct ubi_volume_desc;
  205. /**
  206. * struct ubi_fastmap_layout - in-memory fastmap data structure.
  207. * @e: PEBs used by the current fastmap
  208. * @to_be_tortured: if non-zero tortured this PEB
  209. * @used_blocks: number of used PEBs
  210. * @max_pool_size: maximal size of the user pool
  211. * @max_wl_pool_size: maximal size of the pool used by the WL sub-system
  212. */
  213. struct ubi_fastmap_layout {
  214. struct ubi_wl_entry *e[UBI_FM_MAX_BLOCKS];
  215. int to_be_tortured[UBI_FM_MAX_BLOCKS];
  216. int used_blocks;
  217. int max_pool_size;
  218. int max_wl_pool_size;
  219. };
  220. /**
  221. * struct ubi_fm_pool - in-memory fastmap pool
  222. * @pebs: PEBs in this pool
  223. * @used: number of used PEBs
  224. * @size: total number of PEBs in this pool
  225. * @max_size: maximal size of the pool
  226. *
  227. * A pool gets filled with up to max_size.
  228. * If all PEBs within the pool are used a new fastmap will be written
  229. * to the flash and the pool gets refilled with empty PEBs.
  230. *
  231. */
  232. struct ubi_fm_pool {
  233. int pebs[UBI_FM_MAX_POOL_SIZE];
  234. int used;
  235. int size;
  236. int max_size;
  237. };
  238. /**
  239. * struct ubi_volume - UBI volume description data structure.
  240. * @dev: device object to make use of the the Linux device model
  241. * @cdev: character device object to create character device
  242. * @ubi: reference to the UBI device description object
  243. * @vol_id: volume ID
  244. * @ref_count: volume reference count
  245. * @readers: number of users holding this volume in read-only mode
  246. * @writers: number of users holding this volume in read-write mode
  247. * @exclusive: whether somebody holds this volume in exclusive mode
  248. * @metaonly: whether somebody is altering only meta data of this volume
  249. *
  250. * @reserved_pebs: how many physical eraseblocks are reserved for this volume
  251. * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
  252. * @usable_leb_size: logical eraseblock size without padding
  253. * @used_ebs: how many logical eraseblocks in this volume contain data
  254. * @last_eb_bytes: how many bytes are stored in the last logical eraseblock
  255. * @used_bytes: how many bytes of data this volume contains
  256. * @alignment: volume alignment
  257. * @data_pad: how many bytes are not used at the end of physical eraseblocks to
  258. * satisfy the requested alignment
  259. * @name_len: volume name length
  260. * @name: volume name
  261. *
  262. * @upd_ebs: how many eraseblocks are expected to be updated
  263. * @ch_lnum: LEB number which is being changing by the atomic LEB change
  264. * operation
  265. * @upd_bytes: how many bytes are expected to be received for volume update or
  266. * atomic LEB change
  267. * @upd_received: how many bytes were already received for volume update or
  268. * atomic LEB change
  269. * @upd_buf: update buffer which is used to collect update data or data for
  270. * atomic LEB change
  271. *
  272. * @eba_tbl: EBA table of this volume (LEB->PEB mapping)
  273. * @skip_check: %1 if CRC check of this static volume should be skipped.
  274. * Directly reflects the presence of the
  275. * %UBI_VTBL_SKIP_CRC_CHECK_FLG flag in the vtbl entry
  276. * @checked: %1 if this static volume was checked
  277. * @corrupted: %1 if the volume is corrupted (static volumes only)
  278. * @upd_marker: %1 if the update marker is set for this volume
  279. * @updating: %1 if the volume is being updated
  280. * @changing_leb: %1 if the atomic LEB change ioctl command is in progress
  281. * @direct_writes: %1 if direct writes are enabled for this volume
  282. *
  283. * The @corrupted field indicates that the volume's contents is corrupted.
  284. * Since UBI protects only static volumes, this field is not relevant to
  285. * dynamic volumes - it is user's responsibility to assure their data
  286. * integrity.
  287. *
  288. * The @upd_marker flag indicates that this volume is either being updated at
  289. * the moment or is damaged because of an unclean reboot.
  290. */
  291. struct ubi_volume {
  292. struct device dev;
  293. struct cdev cdev;
  294. struct ubi_device *ubi;
  295. int vol_id;
  296. int ref_count;
  297. int readers;
  298. int writers;
  299. int exclusive;
  300. int metaonly;
  301. int reserved_pebs;
  302. int vol_type;
  303. int usable_leb_size;
  304. int used_ebs;
  305. #ifndef __UBOOT__
  306. int last_eb_bytes;
  307. #else
  308. u32 last_eb_bytes;
  309. #endif
  310. long long used_bytes;
  311. int alignment;
  312. int data_pad;
  313. int name_len;
  314. char name[UBI_VOL_NAME_MAX + 1];
  315. int upd_ebs;
  316. int ch_lnum;
  317. long long upd_bytes;
  318. long long upd_received;
  319. void *upd_buf;
  320. int *eba_tbl;
  321. unsigned int skip_check:1;
  322. unsigned int checked:1;
  323. unsigned int corrupted:1;
  324. unsigned int upd_marker:1;
  325. unsigned int updating:1;
  326. unsigned int changing_leb:1;
  327. unsigned int direct_writes:1;
  328. };
  329. /**
  330. * struct ubi_volume_desc - UBI volume descriptor returned when it is opened.
  331. * @vol: reference to the corresponding volume description object
  332. * @mode: open mode (%UBI_READONLY, %UBI_READWRITE, %UBI_EXCLUSIVE
  333. * or %UBI_METAONLY)
  334. */
  335. struct ubi_volume_desc {
  336. struct ubi_volume *vol;
  337. int mode;
  338. };
  339. struct ubi_wl_entry;
  340. /**
  341. * struct ubi_debug_info - debugging information for an UBI device.
  342. *
  343. * @chk_gen: if UBI general extra checks are enabled
  344. * @chk_io: if UBI I/O extra checks are enabled
  345. * @chk_fastmap: if UBI fastmap extra checks are enabled
  346. * @disable_bgt: disable the background task for testing purposes
  347. * @emulate_bitflips: emulate bit-flips for testing purposes
  348. * @emulate_io_failures: emulate write/erase failures for testing purposes
  349. * @emulate_power_cut: emulate power cut for testing purposes
  350. * @power_cut_counter: count down for writes left until emulated power cut
  351. * @power_cut_min: minimum number of writes before emulating a power cut
  352. * @power_cut_max: maximum number of writes until emulating a power cut
  353. * @dfs_dir_name: name of debugfs directory containing files of this UBI device
  354. * @dfs_dir: direntry object of the UBI device debugfs directory
  355. * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
  356. * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
  357. * @dfs_chk_fastmap: debugfs knob to enable UBI fastmap extra checks
  358. * @dfs_disable_bgt: debugfs knob to disable the background task
  359. * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
  360. * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
  361. * @dfs_emulate_power_cut: debugfs knob to emulate power cuts
  362. * @dfs_power_cut_min: debugfs knob for minimum writes before power cut
  363. * @dfs_power_cut_max: debugfs knob for maximum writes until power cut
  364. */
  365. struct ubi_debug_info {
  366. unsigned int chk_gen:1;
  367. unsigned int chk_io:1;
  368. unsigned int chk_fastmap:1;
  369. unsigned int disable_bgt:1;
  370. unsigned int emulate_bitflips:1;
  371. unsigned int emulate_io_failures:1;
  372. unsigned int emulate_power_cut:2;
  373. unsigned int power_cut_counter;
  374. unsigned int power_cut_min;
  375. unsigned int power_cut_max;
  376. char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
  377. struct dentry *dfs_dir;
  378. struct dentry *dfs_chk_gen;
  379. struct dentry *dfs_chk_io;
  380. struct dentry *dfs_chk_fastmap;
  381. struct dentry *dfs_disable_bgt;
  382. struct dentry *dfs_emulate_bitflips;
  383. struct dentry *dfs_emulate_io_failures;
  384. struct dentry *dfs_emulate_power_cut;
  385. struct dentry *dfs_power_cut_min;
  386. struct dentry *dfs_power_cut_max;
  387. };
  388. /**
  389. * struct ubi_device - UBI device description structure
  390. * @dev: UBI device object to use the the Linux device model
  391. * @cdev: character device object to create character device
  392. * @ubi_num: UBI device number
  393. * @ubi_name: UBI device name
  394. * @vol_count: number of volumes in this UBI device
  395. * @volumes: volumes of this UBI device
  396. * @volumes_lock: protects @volumes, @rsvd_pebs, @avail_pebs, beb_rsvd_pebs,
  397. * @beb_rsvd_level, @bad_peb_count, @good_peb_count, @vol_count,
  398. * @vol->readers, @vol->writers, @vol->exclusive,
  399. * @vol->metaonly, @vol->ref_count, @vol->mapping and
  400. * @vol->eba_tbl.
  401. * @ref_count: count of references on the UBI device
  402. * @image_seq: image sequence number recorded on EC headers
  403. *
  404. * @rsvd_pebs: count of reserved physical eraseblocks
  405. * @avail_pebs: count of available physical eraseblocks
  406. * @beb_rsvd_pebs: how many physical eraseblocks are reserved for bad PEB
  407. * handling
  408. * @beb_rsvd_level: normal level of PEBs reserved for bad PEB handling
  409. *
  410. * @autoresize_vol_id: ID of the volume which has to be auto-resized at the end
  411. * of UBI initialization
  412. * @vtbl_slots: how many slots are available in the volume table
  413. * @vtbl_size: size of the volume table in bytes
  414. * @vtbl: in-RAM volume table copy
  415. * @device_mutex: protects on-flash volume table and serializes volume
  416. * creation, deletion, update, re-size, re-name and set
  417. * property
  418. *
  419. * @max_ec: current highest erase counter value
  420. * @mean_ec: current mean erase counter value
  421. *
  422. * @global_sqnum: global sequence number
  423. * @ltree_lock: protects the lock tree and @global_sqnum
  424. * @ltree: the lock tree
  425. * @alc_mutex: serializes "atomic LEB change" operations
  426. *
  427. * @fm_disabled: non-zero if fastmap is disabled (default)
  428. * @fm: in-memory data structure of the currently used fastmap
  429. * @fm_pool: in-memory data structure of the fastmap pool
  430. * @fm_wl_pool: in-memory data structure of the fastmap pool used by the WL
  431. * sub-system
  432. * @fm_protect: serializes ubi_update_fastmap(), protects @fm_buf and makes sure
  433. * that critical sections cannot be interrupted by ubi_update_fastmap()
  434. * @fm_buf: vmalloc()'d buffer which holds the raw fastmap
  435. * @fm_size: fastmap size in bytes
  436. * @fm_eba_sem: allows ubi_update_fastmap() to block EBA table changes
  437. * @fm_work: fastmap work queue
  438. * @fm_work_scheduled: non-zero if fastmap work was scheduled
  439. *
  440. * @used: RB-tree of used physical eraseblocks
  441. * @erroneous: RB-tree of erroneous used physical eraseblocks
  442. * @free: RB-tree of free physical eraseblocks
  443. * @free_count: Contains the number of elements in @free
  444. * @scrub: RB-tree of physical eraseblocks which need scrubbing
  445. * @pq: protection queue (contain physical eraseblocks which are temporarily
  446. * protected from the wear-leveling worker)
  447. * @pq_head: protection queue head
  448. * @wl_lock: protects the @used, @free, @pq, @pq_head, @lookuptbl, @move_from,
  449. * @move_to, @move_to_put @erase_pending, @wl_scheduled, @works,
  450. * @erroneous, @erroneous_peb_count, @fm_work_scheduled, @fm_pool,
  451. * and @fm_wl_pool fields
  452. * @move_mutex: serializes eraseblock moves
  453. * @work_sem: used to wait for all the scheduled works to finish and prevent
  454. * new works from being submitted
  455. * @wl_scheduled: non-zero if the wear-leveling was scheduled
  456. * @lookuptbl: a table to quickly find a &struct ubi_wl_entry object for any
  457. * physical eraseblock
  458. * @move_from: physical eraseblock from where the data is being moved
  459. * @move_to: physical eraseblock where the data is being moved to
  460. * @move_to_put: if the "to" PEB was put
  461. * @works: list of pending works
  462. * @works_count: count of pending works
  463. * @bgt_thread: background thread description object
  464. * @thread_enabled: if the background thread is enabled
  465. * @bgt_name: background thread name
  466. *
  467. * @flash_size: underlying MTD device size (in bytes)
  468. * @peb_count: count of physical eraseblocks on the MTD device
  469. * @peb_size: physical eraseblock size
  470. * @bad_peb_limit: top limit of expected bad physical eraseblocks
  471. * @bad_peb_count: count of bad physical eraseblocks
  472. * @good_peb_count: count of good physical eraseblocks
  473. * @corr_peb_count: count of corrupted physical eraseblocks (preserved and not
  474. * used by UBI)
  475. * @erroneous_peb_count: count of erroneous physical eraseblocks in @erroneous
  476. * @max_erroneous: maximum allowed amount of erroneous physical eraseblocks
  477. * @min_io_size: minimal input/output unit size of the underlying MTD device
  478. * @hdrs_min_io_size: minimal I/O unit size used for VID and EC headers
  479. * @ro_mode: if the UBI device is in read-only mode
  480. * @leb_size: logical eraseblock size
  481. * @leb_start: starting offset of logical eraseblocks within physical
  482. * eraseblocks
  483. * @ec_hdr_alsize: size of the EC header aligned to @hdrs_min_io_size
  484. * @vid_hdr_alsize: size of the VID header aligned to @hdrs_min_io_size
  485. * @vid_hdr_offset: starting offset of the volume identifier header (might be
  486. * unaligned)
  487. * @vid_hdr_aloffset: starting offset of the VID header aligned to
  488. * @hdrs_min_io_size
  489. * @vid_hdr_shift: contains @vid_hdr_offset - @vid_hdr_aloffset
  490. * @bad_allowed: whether the MTD device admits of bad physical eraseblocks or
  491. * not
  492. * @nor_flash: non-zero if working on top of NOR flash
  493. * @max_write_size: maximum amount of bytes the underlying flash can write at a
  494. * time (MTD write buffer size)
  495. * @mtd: MTD device descriptor
  496. *
  497. * @peb_buf: a buffer of PEB size used for different purposes
  498. * @buf_mutex: protects @peb_buf
  499. * @ckvol_mutex: serializes static volume checking when opening
  500. *
  501. * @dbg: debugging information for this UBI device
  502. */
  503. struct ubi_device {
  504. struct cdev cdev;
  505. struct device dev;
  506. int ubi_num;
  507. char ubi_name[sizeof(UBI_NAME_STR)+5];
  508. int vol_count;
  509. struct ubi_volume *volumes[UBI_MAX_VOLUMES+UBI_INT_VOL_COUNT];
  510. spinlock_t volumes_lock;
  511. int ref_count;
  512. int image_seq;
  513. int rsvd_pebs;
  514. int avail_pebs;
  515. int beb_rsvd_pebs;
  516. int beb_rsvd_level;
  517. int bad_peb_limit;
  518. int autoresize_vol_id;
  519. int vtbl_slots;
  520. int vtbl_size;
  521. struct ubi_vtbl_record *vtbl;
  522. struct mutex device_mutex;
  523. int max_ec;
  524. /* Note, mean_ec is not updated run-time - should be fixed */
  525. int mean_ec;
  526. /* EBA sub-system's stuff */
  527. unsigned long long global_sqnum;
  528. spinlock_t ltree_lock;
  529. struct rb_root ltree;
  530. struct mutex alc_mutex;
  531. /* Fastmap stuff */
  532. int fm_disabled;
  533. struct ubi_fastmap_layout *fm;
  534. struct ubi_fm_pool fm_pool;
  535. struct ubi_fm_pool fm_wl_pool;
  536. struct rw_semaphore fm_eba_sem;
  537. struct rw_semaphore fm_protect;
  538. void *fm_buf;
  539. size_t fm_size;
  540. #ifndef __UBOOT__
  541. struct work_struct fm_work;
  542. #endif
  543. int fm_work_scheduled;
  544. /* Wear-leveling sub-system's stuff */
  545. struct rb_root used;
  546. struct rb_root erroneous;
  547. struct rb_root free;
  548. int free_count;
  549. struct rb_root scrub;
  550. struct list_head pq[UBI_PROT_QUEUE_LEN];
  551. int pq_head;
  552. spinlock_t wl_lock;
  553. struct mutex move_mutex;
  554. struct rw_semaphore work_sem;
  555. int wl_scheduled;
  556. struct ubi_wl_entry **lookuptbl;
  557. struct ubi_wl_entry *move_from;
  558. struct ubi_wl_entry *move_to;
  559. int move_to_put;
  560. struct list_head works;
  561. int works_count;
  562. struct task_struct *bgt_thread;
  563. int thread_enabled;
  564. char bgt_name[sizeof(UBI_BGT_NAME_PATTERN)+2];
  565. /* I/O sub-system's stuff */
  566. long long flash_size;
  567. int peb_count;
  568. int peb_size;
  569. int bad_peb_count;
  570. int good_peb_count;
  571. int corr_peb_count;
  572. int erroneous_peb_count;
  573. int max_erroneous;
  574. int min_io_size;
  575. int hdrs_min_io_size;
  576. int ro_mode;
  577. int leb_size;
  578. int leb_start;
  579. int ec_hdr_alsize;
  580. int vid_hdr_alsize;
  581. int vid_hdr_offset;
  582. int vid_hdr_aloffset;
  583. int vid_hdr_shift;
  584. unsigned int bad_allowed:1;
  585. unsigned int nor_flash:1;
  586. int max_write_size;
  587. struct mtd_info *mtd;
  588. void *peb_buf;
  589. struct mutex buf_mutex;
  590. struct mutex ckvol_mutex;
  591. struct ubi_debug_info dbg;
  592. };
  593. /**
  594. * struct ubi_ainf_peb - attach information about a physical eraseblock.
  595. * @ec: erase counter (%UBI_UNKNOWN if it is unknown)
  596. * @pnum: physical eraseblock number
  597. * @vol_id: ID of the volume this LEB belongs to
  598. * @lnum: logical eraseblock number
  599. * @scrub: if this physical eraseblock needs scrubbing
  600. * @copy_flag: this LEB is a copy (@copy_flag is set in VID header of this LEB)
  601. * @sqnum: sequence number
  602. * @u: unions RB-tree or @list links
  603. * @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
  604. * @u.list: link in one of the eraseblock lists
  605. *
  606. * One object of this type is allocated for each physical eraseblock when
  607. * attaching an MTD device. Note, if this PEB does not belong to any LEB /
  608. * volume, the @vol_id and @lnum fields are initialized to %UBI_UNKNOWN.
  609. */
  610. struct ubi_ainf_peb {
  611. int ec;
  612. int pnum;
  613. int vol_id;
  614. int lnum;
  615. unsigned int scrub:1;
  616. unsigned int copy_flag:1;
  617. unsigned long long sqnum;
  618. union {
  619. struct rb_node rb;
  620. struct list_head list;
  621. } u;
  622. };
  623. /**
  624. * struct ubi_ainf_volume - attaching information about a volume.
  625. * @vol_id: volume ID
  626. * @highest_lnum: highest logical eraseblock number in this volume
  627. * @leb_count: number of logical eraseblocks in this volume
  628. * @vol_type: volume type
  629. * @used_ebs: number of used logical eraseblocks in this volume (only for
  630. * static volumes)
  631. * @last_data_size: amount of data in the last logical eraseblock of this
  632. * volume (always equivalent to the usable logical eraseblock
  633. * size in case of dynamic volumes)
  634. * @data_pad: how many bytes at the end of logical eraseblocks of this volume
  635. * are not used (due to volume alignment)
  636. * @compat: compatibility flags of this volume
  637. * @rb: link in the volume RB-tree
  638. * @root: root of the RB-tree containing all the eraseblock belonging to this
  639. * volume (&struct ubi_ainf_peb objects)
  640. *
  641. * One object of this type is allocated for each volume when attaching an MTD
  642. * device.
  643. */
  644. struct ubi_ainf_volume {
  645. int vol_id;
  646. int highest_lnum;
  647. int leb_count;
  648. int vol_type;
  649. int used_ebs;
  650. int last_data_size;
  651. int data_pad;
  652. int compat;
  653. struct rb_node rb;
  654. struct rb_root root;
  655. };
  656. /**
  657. * struct ubi_attach_info - MTD device attaching information.
  658. * @volumes: root of the volume RB-tree
  659. * @corr: list of corrupted physical eraseblocks
  660. * @free: list of free physical eraseblocks
  661. * @erase: list of physical eraseblocks which have to be erased
  662. * @alien: list of physical eraseblocks which should not be used by UBI (e.g.,
  663. * those belonging to "preserve"-compatible internal volumes)
  664. * @corr_peb_count: count of PEBs in the @corr list
  665. * @empty_peb_count: count of PEBs which are presumably empty (contain only
  666. * 0xFF bytes)
  667. * @alien_peb_count: count of PEBs in the @alien list
  668. * @bad_peb_count: count of bad physical eraseblocks
  669. * @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
  670. * as bad yet, but which look like bad
  671. * @vols_found: number of volumes found
  672. * @highest_vol_id: highest volume ID
  673. * @is_empty: flag indicating whether the MTD device is empty or not
  674. * @min_ec: lowest erase counter value
  675. * @max_ec: highest erase counter value
  676. * @max_sqnum: highest sequence number value
  677. * @mean_ec: mean erase counter value
  678. * @ec_sum: a temporary variable used when calculating @mean_ec
  679. * @ec_count: a temporary variable used when calculating @mean_ec
  680. * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
  681. *
  682. * This data structure contains the result of attaching an MTD device and may
  683. * be used by other UBI sub-systems to build final UBI data structures, further
  684. * error-recovery and so on.
  685. */
  686. struct ubi_attach_info {
  687. struct rb_root volumes;
  688. struct list_head corr;
  689. struct list_head free;
  690. struct list_head erase;
  691. struct list_head alien;
  692. int corr_peb_count;
  693. int empty_peb_count;
  694. int alien_peb_count;
  695. int bad_peb_count;
  696. int maybe_bad_peb_count;
  697. int vols_found;
  698. int highest_vol_id;
  699. int is_empty;
  700. int min_ec;
  701. int max_ec;
  702. unsigned long long max_sqnum;
  703. int mean_ec;
  704. uint64_t ec_sum;
  705. int ec_count;
  706. struct kmem_cache *aeb_slab_cache;
  707. };
  708. /**
  709. * struct ubi_work - UBI work description data structure.
  710. * @list: a link in the list of pending works
  711. * @func: worker function
  712. * @e: physical eraseblock to erase
  713. * @vol_id: the volume ID on which this erasure is being performed
  714. * @lnum: the logical eraseblock number
  715. * @torture: if the physical eraseblock has to be tortured
  716. * @anchor: produce a anchor PEB to by used by fastmap
  717. *
  718. * The @func pointer points to the worker function. If the @shutdown argument is
  719. * not zero, the worker has to free the resources and exit immediately as the
  720. * WL sub-system is shutting down.
  721. * The worker has to return zero in case of success and a negative error code in
  722. * case of failure.
  723. */
  724. struct ubi_work {
  725. struct list_head list;
  726. int (*func)(struct ubi_device *ubi, struct ubi_work *wrk, int shutdown);
  727. /* The below fields are only relevant to erasure works */
  728. struct ubi_wl_entry *e;
  729. int vol_id;
  730. int lnum;
  731. int torture;
  732. int anchor;
  733. };
  734. #include "debug.h"
  735. extern struct kmem_cache *ubi_wl_entry_slab;
  736. extern const struct file_operations ubi_ctrl_cdev_operations;
  737. extern const struct file_operations ubi_cdev_operations;
  738. extern const struct file_operations ubi_vol_cdev_operations;
  739. extern struct class ubi_class;
  740. extern struct mutex ubi_devices_mutex;
  741. extern struct blocking_notifier_head ubi_notifiers;
  742. /* attach.c */
  743. int ubi_add_to_av(struct ubi_device *ubi, struct ubi_attach_info *ai, int pnum,
  744. int ec, const struct ubi_vid_hdr *vid_hdr, int bitflips);
  745. struct ubi_ainf_volume *ubi_find_av(const struct ubi_attach_info *ai,
  746. int vol_id);
  747. void ubi_remove_av(struct ubi_attach_info *ai, struct ubi_ainf_volume *av);
  748. struct ubi_ainf_peb *ubi_early_get_peb(struct ubi_device *ubi,
  749. struct ubi_attach_info *ai);
  750. int ubi_attach(struct ubi_device *ubi, int force_scan);
  751. void ubi_destroy_ai(struct ubi_attach_info *ai);
  752. /* vtbl.c */
  753. int ubi_change_vtbl_record(struct ubi_device *ubi, int idx,
  754. struct ubi_vtbl_record *vtbl_rec);
  755. int ubi_vtbl_rename_volumes(struct ubi_device *ubi,
  756. struct list_head *rename_list);
  757. int ubi_read_volume_table(struct ubi_device *ubi, struct ubi_attach_info *ai);
  758. /* vmt.c */
  759. int ubi_create_volume(struct ubi_device *ubi, struct ubi_mkvol_req *req);
  760. int ubi_remove_volume(struct ubi_volume_desc *desc, int no_vtbl);
  761. int ubi_resize_volume(struct ubi_volume_desc *desc, int reserved_pebs);
  762. int ubi_rename_volumes(struct ubi_device *ubi, struct list_head *rename_list);
  763. int ubi_add_volume(struct ubi_device *ubi, struct ubi_volume *vol);
  764. void ubi_free_volume(struct ubi_device *ubi, struct ubi_volume *vol);
  765. /* upd.c */
  766. int ubi_start_update(struct ubi_device *ubi, struct ubi_volume *vol,
  767. long long bytes);
  768. int ubi_more_update_data(struct ubi_device *ubi, struct ubi_volume *vol,
  769. const void __user *buf, int count);
  770. int ubi_start_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
  771. const struct ubi_leb_change_req *req);
  772. int ubi_more_leb_change_data(struct ubi_device *ubi, struct ubi_volume *vol,
  773. const void __user *buf, int count);
  774. /* misc.c */
  775. int ubi_calc_data_len(const struct ubi_device *ubi, const void *buf,
  776. int length);
  777. int ubi_check_volume(struct ubi_device *ubi, int vol_id);
  778. void ubi_update_reserved(struct ubi_device *ubi);
  779. void ubi_calculate_reserved(struct ubi_device *ubi);
  780. int ubi_check_pattern(const void *buf, uint8_t patt, int size);
  781. /* gluebi.c */
  782. #ifdef CONFIG_MTD_UBI_GLUEBI
  783. int ubi_create_gluebi(struct ubi_device *ubi, struct ubi_volume *vol);
  784. int ubi_destroy_gluebi(struct ubi_volume *vol);
  785. void ubi_gluebi_updated(struct ubi_volume *vol);
  786. #else
  787. #define ubi_create_gluebi(ubi, vol) 0
  788. static inline int ubi_destroy_gluebi(struct ubi_volume *vol)
  789. {
  790. return 0;
  791. }
  792. #define ubi_gluebi_updated(vol)
  793. #endif
  794. /* eba.c */
  795. int ubi_eba_unmap_leb(struct ubi_device *ubi, struct ubi_volume *vol,
  796. int lnum);
  797. int ubi_eba_read_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
  798. void *buf, int offset, int len, int check);
  799. int ubi_eba_read_leb_sg(struct ubi_device *ubi, struct ubi_volume *vol,
  800. struct ubi_sgl *sgl, int lnum, int offset, int len,
  801. int check);
  802. int ubi_eba_write_leb(struct ubi_device *ubi, struct ubi_volume *vol, int lnum,
  803. const void *buf, int offset, int len);
  804. int ubi_eba_write_leb_st(struct ubi_device *ubi, struct ubi_volume *vol,
  805. int lnum, const void *buf, int len, int used_ebs);
  806. int ubi_eba_atomic_leb_change(struct ubi_device *ubi, struct ubi_volume *vol,
  807. int lnum, const void *buf, int len);
  808. int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
  809. struct ubi_vid_hdr *vid_hdr);
  810. int ubi_eba_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
  811. unsigned long long ubi_next_sqnum(struct ubi_device *ubi);
  812. int self_check_eba(struct ubi_device *ubi, struct ubi_attach_info *ai_fastmap,
  813. struct ubi_attach_info *ai_scan);
  814. /* wl.c */
  815. int ubi_wl_get_peb(struct ubi_device *ubi);
  816. int ubi_wl_put_peb(struct ubi_device *ubi, int vol_id, int lnum,
  817. int pnum, int torture);
  818. int ubi_wl_flush(struct ubi_device *ubi, int vol_id, int lnum);
  819. int ubi_wl_scrub_peb(struct ubi_device *ubi, int pnum);
  820. int ubi_wl_init(struct ubi_device *ubi, struct ubi_attach_info *ai);
  821. void ubi_wl_close(struct ubi_device *ubi);
  822. int ubi_thread(void *u);
  823. struct ubi_wl_entry *ubi_wl_get_fm_peb(struct ubi_device *ubi, int anchor);
  824. int ubi_wl_put_fm_peb(struct ubi_device *ubi, struct ubi_wl_entry *used_e,
  825. int lnum, int torture);
  826. int ubi_is_erase_work(struct ubi_work *wrk);
  827. void ubi_refill_pools(struct ubi_device *ubi);
  828. int ubi_ensure_anchor_pebs(struct ubi_device *ubi);
  829. /* io.c */
  830. int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
  831. int len);
  832. int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
  833. int len);
  834. int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture);
  835. int ubi_io_is_bad(const struct ubi_device *ubi, int pnum);
  836. int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum);
  837. int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
  838. struct ubi_ec_hdr *ec_hdr, int verbose);
  839. int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
  840. struct ubi_ec_hdr *ec_hdr);
  841. int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
  842. struct ubi_vid_hdr *vid_hdr, int verbose);
  843. int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
  844. struct ubi_vid_hdr *vid_hdr);
  845. /* build.c */
  846. int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
  847. int vid_hdr_offset, int max_beb_per1024);
  848. int ubi_detach_mtd_dev(int ubi_num, int anyway);
  849. struct ubi_device *ubi_get_device(int ubi_num);
  850. void ubi_put_device(struct ubi_device *ubi);
  851. struct ubi_device *ubi_get_by_major(int major);
  852. int ubi_major2num(int major);
  853. int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol,
  854. int ntype);
  855. int ubi_notify_all(struct ubi_device *ubi, int ntype,
  856. struct notifier_block *nb);
  857. int ubi_enumerate_volumes(struct notifier_block *nb);
  858. void ubi_free_internal_volumes(struct ubi_device *ubi);
  859. /* kapi.c */
  860. void ubi_do_get_device_info(struct ubi_device *ubi, struct ubi_device_info *di);
  861. void ubi_do_get_volume_info(struct ubi_device *ubi, struct ubi_volume *vol,
  862. struct ubi_volume_info *vi);
  863. /* scan.c */
  864. int ubi_compare_lebs(struct ubi_device *ubi, const struct ubi_ainf_peb *aeb,
  865. int pnum, const struct ubi_vid_hdr *vid_hdr);
  866. /* fastmap.c */
  867. #ifdef CONFIG_MTD_UBI_FASTMAP
  868. size_t ubi_calc_fm_size(struct ubi_device *ubi);
  869. int ubi_update_fastmap(struct ubi_device *ubi);
  870. int ubi_scan_fastmap(struct ubi_device *ubi, struct ubi_attach_info *ai,
  871. int fm_anchor);
  872. #else
  873. static inline int ubi_update_fastmap(struct ubi_device *ubi) { return 0; }
  874. #endif
  875. /* block.c */
  876. #ifdef CONFIG_MTD_UBI_BLOCK
  877. int ubiblock_init(void);
  878. void ubiblock_exit(void);
  879. int ubiblock_create(struct ubi_volume_info *vi);
  880. int ubiblock_remove(struct ubi_volume_info *vi);
  881. #else
  882. static inline int ubiblock_init(void) { return 0; }
  883. static inline void ubiblock_exit(void) {}
  884. static inline int ubiblock_create(struct ubi_volume_info *vi)
  885. {
  886. return -ENOSYS;
  887. }
  888. static inline int ubiblock_remove(struct ubi_volume_info *vi)
  889. {
  890. return -ENOSYS;
  891. }
  892. #endif
  893. /*
  894. * ubi_for_each_free_peb - walk the UBI free RB tree.
  895. * @ubi: UBI device description object
  896. * @e: a pointer to a ubi_wl_entry to use as cursor
  897. * @pos: a pointer to RB-tree entry type to use as a loop counter
  898. */
  899. #define ubi_for_each_free_peb(ubi, e, tmp_rb) \
  900. ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->free, u.rb)
  901. /*
  902. * ubi_for_each_used_peb - walk the UBI used RB tree.
  903. * @ubi: UBI device description object
  904. * @e: a pointer to a ubi_wl_entry to use as cursor
  905. * @pos: a pointer to RB-tree entry type to use as a loop counter
  906. */
  907. #define ubi_for_each_used_peb(ubi, e, tmp_rb) \
  908. ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->used, u.rb)
  909. /*
  910. * ubi_for_each_scub_peb - walk the UBI scub RB tree.
  911. * @ubi: UBI device description object
  912. * @e: a pointer to a ubi_wl_entry to use as cursor
  913. * @pos: a pointer to RB-tree entry type to use as a loop counter
  914. */
  915. #define ubi_for_each_scrub_peb(ubi, e, tmp_rb) \
  916. ubi_rb_for_each_entry((tmp_rb), (e), &(ubi)->scrub, u.rb)
  917. /*
  918. * ubi_for_each_protected_peb - walk the UBI protection queue.
  919. * @ubi: UBI device description object
  920. * @i: a integer used as counter
  921. * @e: a pointer to a ubi_wl_entry to use as cursor
  922. */
  923. #define ubi_for_each_protected_peb(ubi, i, e) \
  924. for ((i) = 0; (i) < UBI_PROT_QUEUE_LEN; (i)++) \
  925. list_for_each_entry((e), &(ubi->pq[(i)]), u.list)
  926. /*
  927. * ubi_rb_for_each_entry - walk an RB-tree.
  928. * @rb: a pointer to type 'struct rb_node' to use as a loop counter
  929. * @pos: a pointer to RB-tree entry type to use as a loop counter
  930. * @root: RB-tree's root
  931. * @member: the name of the 'struct rb_node' within the RB-tree entry
  932. */
  933. #define ubi_rb_for_each_entry(rb, pos, root, member) \
  934. for (rb = rb_first(root), \
  935. pos = (rb ? container_of(rb, typeof(*pos), member) : NULL); \
  936. rb; \
  937. rb = rb_next(rb), \
  938. pos = (rb ? container_of(rb, typeof(*pos), member) : NULL))
  939. /*
  940. * ubi_move_aeb_to_list - move a PEB from the volume tree to a list.
  941. *
  942. * @av: volume attaching information
  943. * @aeb: attaching eraseblock information
  944. * @list: the list to move to
  945. */
  946. static inline void ubi_move_aeb_to_list(struct ubi_ainf_volume *av,
  947. struct ubi_ainf_peb *aeb,
  948. struct list_head *list)
  949. {
  950. rb_erase(&aeb->u.rb, &av->root);
  951. list_add_tail(&aeb->u.list, list);
  952. }
  953. /**
  954. * ubi_zalloc_vid_hdr - allocate a volume identifier header object.
  955. * @ubi: UBI device description object
  956. * @gfp_flags: GFP flags to allocate with
  957. *
  958. * This function returns a pointer to the newly allocated and zero-filled
  959. * volume identifier header object in case of success and %NULL in case of
  960. * failure.
  961. */
  962. static inline struct ubi_vid_hdr *
  963. ubi_zalloc_vid_hdr(const struct ubi_device *ubi, gfp_t gfp_flags)
  964. {
  965. void *vid_hdr;
  966. vid_hdr = kzalloc(ubi->vid_hdr_alsize, gfp_flags);
  967. if (!vid_hdr)
  968. return NULL;
  969. /*
  970. * VID headers may be stored at un-aligned flash offsets, so we shift
  971. * the pointer.
  972. */
  973. return vid_hdr + ubi->vid_hdr_shift;
  974. }
  975. /**
  976. * ubi_free_vid_hdr - free a volume identifier header object.
  977. * @ubi: UBI device description object
  978. * @vid_hdr: the object to free
  979. */
  980. static inline void ubi_free_vid_hdr(const struct ubi_device *ubi,
  981. struct ubi_vid_hdr *vid_hdr)
  982. {
  983. void *p = vid_hdr;
  984. if (!p)
  985. return;
  986. kfree(p - ubi->vid_hdr_shift);
  987. }
  988. /*
  989. * This function is equivalent to 'ubi_io_read()', but @offset is relative to
  990. * the beginning of the logical eraseblock, not to the beginning of the
  991. * physical eraseblock.
  992. */
  993. static inline int ubi_io_read_data(const struct ubi_device *ubi, void *buf,
  994. int pnum, int offset, int len)
  995. {
  996. ubi_assert(offset >= 0);
  997. return ubi_io_read(ubi, buf, pnum, offset + ubi->leb_start, len);
  998. }
  999. /*
  1000. * This function is equivalent to 'ubi_io_write()', but @offset is relative to
  1001. * the beginning of the logical eraseblock, not to the beginning of the
  1002. * physical eraseblock.
  1003. */
  1004. static inline int ubi_io_write_data(struct ubi_device *ubi, const void *buf,
  1005. int pnum, int offset, int len)
  1006. {
  1007. ubi_assert(offset >= 0);
  1008. return ubi_io_write(ubi, buf, pnum, offset + ubi->leb_start, len);
  1009. }
  1010. /**
  1011. * ubi_ro_mode - switch to read-only mode.
  1012. * @ubi: UBI device description object
  1013. */
  1014. static inline void ubi_ro_mode(struct ubi_device *ubi)
  1015. {
  1016. if (!ubi->ro_mode) {
  1017. ubi->ro_mode = 1;
  1018. ubi_warn(ubi, "switch to read-only mode");
  1019. dump_stack();
  1020. }
  1021. }
  1022. /**
  1023. * vol_id2idx - get table index by volume ID.
  1024. * @ubi: UBI device description object
  1025. * @vol_id: volume ID
  1026. */
  1027. static inline int vol_id2idx(const struct ubi_device *ubi, int vol_id)
  1028. {
  1029. if (vol_id >= UBI_INTERNAL_VOL_START)
  1030. return vol_id - UBI_INTERNAL_VOL_START + ubi->vtbl_slots;
  1031. else
  1032. return vol_id;
  1033. }
  1034. /**
  1035. * idx2vol_id - get volume ID by table index.
  1036. * @ubi: UBI device description object
  1037. * @idx: table index
  1038. */
  1039. static inline int idx2vol_id(const struct ubi_device *ubi, int idx)
  1040. {
  1041. if (idx >= ubi->vtbl_slots)
  1042. return idx - ubi->vtbl_slots + UBI_INTERNAL_VOL_START;
  1043. else
  1044. return idx;
  1045. }
  1046. #ifdef __UBOOT__
  1047. void ubi_do_worker(struct ubi_device *ubi);
  1048. #endif
  1049. #endif /* !__UBI_UBI_H__ */