build.c 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398
  1. /*
  2. * Copyright (c) International Business Machines Corp., 2006
  3. * Copyright (c) Nokia Corporation, 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. * Frank Haverkamp
  21. */
  22. /*
  23. * This file includes UBI initialization and building of UBI devices.
  24. *
  25. * When UBI is initialized, it attaches all the MTD devices specified as the
  26. * module load parameters or the kernel boot parameters. If MTD devices were
  27. * specified, UBI does not attach any MTD device, but it is possible to do
  28. * later using the "UBI control device".
  29. *
  30. * At the moment we only attach UBI devices by scanning, which will become a
  31. * bottleneck when flashes reach certain large size. Then one may improve UBI
  32. * and add other methods, although it does not seem to be easy to do.
  33. */
  34. #include <linux/err.h>
  35. #include <linux/module.h>
  36. #include <linux/moduleparam.h>
  37. #include <linux/stringify.h>
  38. #include <linux/namei.h>
  39. #include <linux/stat.h>
  40. #include <linux/miscdevice.h>
  41. #include <linux/log2.h>
  42. #include <linux/kthread.h>
  43. #include <linux/kernel.h>
  44. #include <linux/slab.h>
  45. #include "ubi.h"
  46. /* Maximum length of the 'mtd=' parameter */
  47. #define MTD_PARAM_LEN_MAX 64
  48. #ifdef CONFIG_MTD_UBI_MODULE
  49. #define ubi_is_module() 1
  50. #else
  51. #define ubi_is_module() 0
  52. #endif
  53. /**
  54. * struct mtd_dev_param - MTD device parameter description data structure.
  55. * @name: MTD character device node path, MTD device name, or MTD device number
  56. * string
  57. * @vid_hdr_offs: VID header offset
  58. */
  59. struct mtd_dev_param {
  60. char name[MTD_PARAM_LEN_MAX];
  61. int vid_hdr_offs;
  62. };
  63. /* Numbers of elements set in the @mtd_dev_param array */
  64. static int __initdata mtd_devs;
  65. /* MTD devices specification parameters */
  66. static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
  67. /* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
  68. struct class *ubi_class;
  69. /* Slab cache for wear-leveling entries */
  70. struct kmem_cache *ubi_wl_entry_slab;
  71. /* UBI control character device */
  72. static struct miscdevice ubi_ctrl_cdev = {
  73. .minor = MISC_DYNAMIC_MINOR,
  74. .name = "ubi_ctrl",
  75. .fops = &ubi_ctrl_cdev_operations,
  76. };
  77. /* All UBI devices in system */
  78. static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
  79. /* Serializes UBI devices creations and removals */
  80. DEFINE_MUTEX(ubi_devices_mutex);
  81. /* Protects @ubi_devices and @ubi->ref_count */
  82. static DEFINE_SPINLOCK(ubi_devices_lock);
  83. /* "Show" method for files in '/<sysfs>/class/ubi/' */
  84. static ssize_t ubi_version_show(struct class *class, struct class_attribute *attr,
  85. char *buf)
  86. {
  87. return sprintf(buf, "%d\n", UBI_VERSION);
  88. }
  89. /* UBI version attribute ('/<sysfs>/class/ubi/version') */
  90. static struct class_attribute ubi_version =
  91. __ATTR(version, S_IRUGO, ubi_version_show, NULL);
  92. static ssize_t dev_attribute_show(struct device *dev,
  93. struct device_attribute *attr, char *buf);
  94. /* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
  95. static struct device_attribute dev_eraseblock_size =
  96. __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
  97. static struct device_attribute dev_avail_eraseblocks =
  98. __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
  99. static struct device_attribute dev_total_eraseblocks =
  100. __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
  101. static struct device_attribute dev_volumes_count =
  102. __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
  103. static struct device_attribute dev_max_ec =
  104. __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
  105. static struct device_attribute dev_reserved_for_bad =
  106. __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
  107. static struct device_attribute dev_bad_peb_count =
  108. __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
  109. static struct device_attribute dev_max_vol_count =
  110. __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
  111. static struct device_attribute dev_min_io_size =
  112. __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
  113. static struct device_attribute dev_bgt_enabled =
  114. __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
  115. static struct device_attribute dev_mtd_num =
  116. __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
  117. /**
  118. * ubi_volume_notify - send a volume change notification.
  119. * @ubi: UBI device description object
  120. * @vol: volume description object of the changed volume
  121. * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
  122. *
  123. * This is a helper function which notifies all subscribers about a volume
  124. * change event (creation, removal, re-sizing, re-naming, updating). Returns
  125. * zero in case of success and a negative error code in case of failure.
  126. */
  127. int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
  128. {
  129. struct ubi_notification nt;
  130. ubi_do_get_device_info(ubi, &nt.di);
  131. ubi_do_get_volume_info(ubi, vol, &nt.vi);
  132. return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
  133. }
  134. /**
  135. * ubi_notify_all - send a notification to all volumes.
  136. * @ubi: UBI device description object
  137. * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
  138. * @nb: the notifier to call
  139. *
  140. * This function walks all volumes of UBI device @ubi and sends the @ntype
  141. * notification for each volume. If @nb is %NULL, then all registered notifiers
  142. * are called, otherwise only the @nb notifier is called. Returns the number of
  143. * sent notifications.
  144. */
  145. int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
  146. {
  147. struct ubi_notification nt;
  148. int i, count = 0;
  149. ubi_do_get_device_info(ubi, &nt.di);
  150. mutex_lock(&ubi->device_mutex);
  151. for (i = 0; i < ubi->vtbl_slots; i++) {
  152. /*
  153. * Since the @ubi->device is locked, and we are not going to
  154. * change @ubi->volumes, we do not have to lock
  155. * @ubi->volumes_lock.
  156. */
  157. if (!ubi->volumes[i])
  158. continue;
  159. ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
  160. if (nb)
  161. nb->notifier_call(nb, ntype, &nt);
  162. else
  163. blocking_notifier_call_chain(&ubi_notifiers, ntype,
  164. &nt);
  165. count += 1;
  166. }
  167. mutex_unlock(&ubi->device_mutex);
  168. return count;
  169. }
  170. /**
  171. * ubi_enumerate_volumes - send "add" notification for all existing volumes.
  172. * @nb: the notifier to call
  173. *
  174. * This function walks all UBI devices and volumes and sends the
  175. * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
  176. * registered notifiers are called, otherwise only the @nb notifier is called.
  177. * Returns the number of sent notifications.
  178. */
  179. int ubi_enumerate_volumes(struct notifier_block *nb)
  180. {
  181. int i, count = 0;
  182. /*
  183. * Since the @ubi_devices_mutex is locked, and we are not going to
  184. * change @ubi_devices, we do not have to lock @ubi_devices_lock.
  185. */
  186. for (i = 0; i < UBI_MAX_DEVICES; i++) {
  187. struct ubi_device *ubi = ubi_devices[i];
  188. if (!ubi)
  189. continue;
  190. count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
  191. }
  192. return count;
  193. }
  194. /**
  195. * ubi_get_device - get UBI device.
  196. * @ubi_num: UBI device number
  197. *
  198. * This function returns UBI device description object for UBI device number
  199. * @ubi_num, or %NULL if the device does not exist. This function increases the
  200. * device reference count to prevent removal of the device. In other words, the
  201. * device cannot be removed if its reference count is not zero.
  202. */
  203. struct ubi_device *ubi_get_device(int ubi_num)
  204. {
  205. struct ubi_device *ubi;
  206. spin_lock(&ubi_devices_lock);
  207. ubi = ubi_devices[ubi_num];
  208. if (ubi) {
  209. ubi_assert(ubi->ref_count >= 0);
  210. ubi->ref_count += 1;
  211. get_device(&ubi->dev);
  212. }
  213. spin_unlock(&ubi_devices_lock);
  214. return ubi;
  215. }
  216. /**
  217. * ubi_put_device - drop an UBI device reference.
  218. * @ubi: UBI device description object
  219. */
  220. void ubi_put_device(struct ubi_device *ubi)
  221. {
  222. spin_lock(&ubi_devices_lock);
  223. ubi->ref_count -= 1;
  224. put_device(&ubi->dev);
  225. spin_unlock(&ubi_devices_lock);
  226. }
  227. /**
  228. * ubi_get_by_major - get UBI device by character device major number.
  229. * @major: major number
  230. *
  231. * This function is similar to 'ubi_get_device()', but it searches the device
  232. * by its major number.
  233. */
  234. struct ubi_device *ubi_get_by_major(int major)
  235. {
  236. int i;
  237. struct ubi_device *ubi;
  238. spin_lock(&ubi_devices_lock);
  239. for (i = 0; i < UBI_MAX_DEVICES; i++) {
  240. ubi = ubi_devices[i];
  241. if (ubi && MAJOR(ubi->cdev.dev) == major) {
  242. ubi_assert(ubi->ref_count >= 0);
  243. ubi->ref_count += 1;
  244. get_device(&ubi->dev);
  245. spin_unlock(&ubi_devices_lock);
  246. return ubi;
  247. }
  248. }
  249. spin_unlock(&ubi_devices_lock);
  250. return NULL;
  251. }
  252. /**
  253. * ubi_major2num - get UBI device number by character device major number.
  254. * @major: major number
  255. *
  256. * This function searches UBI device number object by its major number. If UBI
  257. * device was not found, this function returns -ENODEV, otherwise the UBI device
  258. * number is returned.
  259. */
  260. int ubi_major2num(int major)
  261. {
  262. int i, ubi_num = -ENODEV;
  263. spin_lock(&ubi_devices_lock);
  264. for (i = 0; i < UBI_MAX_DEVICES; i++) {
  265. struct ubi_device *ubi = ubi_devices[i];
  266. if (ubi && MAJOR(ubi->cdev.dev) == major) {
  267. ubi_num = ubi->ubi_num;
  268. break;
  269. }
  270. }
  271. spin_unlock(&ubi_devices_lock);
  272. return ubi_num;
  273. }
  274. /* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
  275. static ssize_t dev_attribute_show(struct device *dev,
  276. struct device_attribute *attr, char *buf)
  277. {
  278. ssize_t ret;
  279. struct ubi_device *ubi;
  280. /*
  281. * The below code looks weird, but it actually makes sense. We get the
  282. * UBI device reference from the contained 'struct ubi_device'. But it
  283. * is unclear if the device was removed or not yet. Indeed, if the
  284. * device was removed before we increased its reference count,
  285. * 'ubi_get_device()' will return -ENODEV and we fail.
  286. *
  287. * Remember, 'struct ubi_device' is freed in the release function, so
  288. * we still can use 'ubi->ubi_num'.
  289. */
  290. ubi = container_of(dev, struct ubi_device, dev);
  291. ubi = ubi_get_device(ubi->ubi_num);
  292. if (!ubi)
  293. return -ENODEV;
  294. if (attr == &dev_eraseblock_size)
  295. ret = sprintf(buf, "%d\n", ubi->leb_size);
  296. else if (attr == &dev_avail_eraseblocks)
  297. ret = sprintf(buf, "%d\n", ubi->avail_pebs);
  298. else if (attr == &dev_total_eraseblocks)
  299. ret = sprintf(buf, "%d\n", ubi->good_peb_count);
  300. else if (attr == &dev_volumes_count)
  301. ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
  302. else if (attr == &dev_max_ec)
  303. ret = sprintf(buf, "%d\n", ubi->max_ec);
  304. else if (attr == &dev_reserved_for_bad)
  305. ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
  306. else if (attr == &dev_bad_peb_count)
  307. ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
  308. else if (attr == &dev_max_vol_count)
  309. ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
  310. else if (attr == &dev_min_io_size)
  311. ret = sprintf(buf, "%d\n", ubi->min_io_size);
  312. else if (attr == &dev_bgt_enabled)
  313. ret = sprintf(buf, "%d\n", ubi->thread_enabled);
  314. else if (attr == &dev_mtd_num)
  315. ret = sprintf(buf, "%d\n", ubi->mtd->index);
  316. else
  317. ret = -EINVAL;
  318. ubi_put_device(ubi);
  319. return ret;
  320. }
  321. static void dev_release(struct device *dev)
  322. {
  323. struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
  324. kfree(ubi);
  325. }
  326. /**
  327. * ubi_sysfs_init - initialize sysfs for an UBI device.
  328. * @ubi: UBI device description object
  329. * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
  330. * taken
  331. *
  332. * This function returns zero in case of success and a negative error code in
  333. * case of failure.
  334. */
  335. static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
  336. {
  337. int err;
  338. ubi->dev.release = dev_release;
  339. ubi->dev.devt = ubi->cdev.dev;
  340. ubi->dev.class = ubi_class;
  341. dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
  342. err = device_register(&ubi->dev);
  343. if (err)
  344. return err;
  345. *ref = 1;
  346. err = device_create_file(&ubi->dev, &dev_eraseblock_size);
  347. if (err)
  348. return err;
  349. err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
  350. if (err)
  351. return err;
  352. err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
  353. if (err)
  354. return err;
  355. err = device_create_file(&ubi->dev, &dev_volumes_count);
  356. if (err)
  357. return err;
  358. err = device_create_file(&ubi->dev, &dev_max_ec);
  359. if (err)
  360. return err;
  361. err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
  362. if (err)
  363. return err;
  364. err = device_create_file(&ubi->dev, &dev_bad_peb_count);
  365. if (err)
  366. return err;
  367. err = device_create_file(&ubi->dev, &dev_max_vol_count);
  368. if (err)
  369. return err;
  370. err = device_create_file(&ubi->dev, &dev_min_io_size);
  371. if (err)
  372. return err;
  373. err = device_create_file(&ubi->dev, &dev_bgt_enabled);
  374. if (err)
  375. return err;
  376. err = device_create_file(&ubi->dev, &dev_mtd_num);
  377. return err;
  378. }
  379. /**
  380. * ubi_sysfs_close - close sysfs for an UBI device.
  381. * @ubi: UBI device description object
  382. */
  383. static void ubi_sysfs_close(struct ubi_device *ubi)
  384. {
  385. device_remove_file(&ubi->dev, &dev_mtd_num);
  386. device_remove_file(&ubi->dev, &dev_bgt_enabled);
  387. device_remove_file(&ubi->dev, &dev_min_io_size);
  388. device_remove_file(&ubi->dev, &dev_max_vol_count);
  389. device_remove_file(&ubi->dev, &dev_bad_peb_count);
  390. device_remove_file(&ubi->dev, &dev_reserved_for_bad);
  391. device_remove_file(&ubi->dev, &dev_max_ec);
  392. device_remove_file(&ubi->dev, &dev_volumes_count);
  393. device_remove_file(&ubi->dev, &dev_total_eraseblocks);
  394. device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
  395. device_remove_file(&ubi->dev, &dev_eraseblock_size);
  396. device_unregister(&ubi->dev);
  397. }
  398. /**
  399. * kill_volumes - destroy all user volumes.
  400. * @ubi: UBI device description object
  401. */
  402. static void kill_volumes(struct ubi_device *ubi)
  403. {
  404. int i;
  405. for (i = 0; i < ubi->vtbl_slots; i++)
  406. if (ubi->volumes[i])
  407. ubi_free_volume(ubi, ubi->volumes[i]);
  408. }
  409. /**
  410. * uif_init - initialize user interfaces for an UBI device.
  411. * @ubi: UBI device description object
  412. * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
  413. * taken, otherwise set to %0
  414. *
  415. * This function initializes various user interfaces for an UBI device. If the
  416. * initialization fails at an early stage, this function frees all the
  417. * resources it allocated, returns an error, and @ref is set to %0. However,
  418. * if the initialization fails after the UBI device was registered in the
  419. * driver core subsystem, this function takes a reference to @ubi->dev, because
  420. * otherwise the release function ('dev_release()') would free whole @ubi
  421. * object. The @ref argument is set to %1 in this case. The caller has to put
  422. * this reference.
  423. *
  424. * This function returns zero in case of success and a negative error code in
  425. * case of failure.
  426. */
  427. static int uif_init(struct ubi_device *ubi, int *ref)
  428. {
  429. int i, err;
  430. dev_t dev;
  431. *ref = 0;
  432. sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
  433. /*
  434. * Major numbers for the UBI character devices are allocated
  435. * dynamically. Major numbers of volume character devices are
  436. * equivalent to ones of the corresponding UBI character device. Minor
  437. * numbers of UBI character devices are 0, while minor numbers of
  438. * volume character devices start from 1. Thus, we allocate one major
  439. * number and ubi->vtbl_slots + 1 minor numbers.
  440. */
  441. err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
  442. if (err) {
  443. ubi_err("cannot register UBI character devices");
  444. return err;
  445. }
  446. ubi_assert(MINOR(dev) == 0);
  447. cdev_init(&ubi->cdev, &ubi_cdev_operations);
  448. dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
  449. ubi->cdev.owner = THIS_MODULE;
  450. err = cdev_add(&ubi->cdev, dev, 1);
  451. if (err) {
  452. ubi_err("cannot add character device");
  453. goto out_unreg;
  454. }
  455. err = ubi_sysfs_init(ubi, ref);
  456. if (err)
  457. goto out_sysfs;
  458. for (i = 0; i < ubi->vtbl_slots; i++)
  459. if (ubi->volumes[i]) {
  460. err = ubi_add_volume(ubi, ubi->volumes[i]);
  461. if (err) {
  462. ubi_err("cannot add volume %d", i);
  463. goto out_volumes;
  464. }
  465. }
  466. return 0;
  467. out_volumes:
  468. kill_volumes(ubi);
  469. out_sysfs:
  470. if (*ref)
  471. get_device(&ubi->dev);
  472. ubi_sysfs_close(ubi);
  473. cdev_del(&ubi->cdev);
  474. out_unreg:
  475. unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
  476. ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
  477. return err;
  478. }
  479. /**
  480. * uif_close - close user interfaces for an UBI device.
  481. * @ubi: UBI device description object
  482. *
  483. * Note, since this function un-registers UBI volume device objects (@vol->dev),
  484. * the memory allocated voe the volumes is freed as well (in the release
  485. * function).
  486. */
  487. static void uif_close(struct ubi_device *ubi)
  488. {
  489. kill_volumes(ubi);
  490. ubi_sysfs_close(ubi);
  491. cdev_del(&ubi->cdev);
  492. unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
  493. }
  494. /**
  495. * free_internal_volumes - free internal volumes.
  496. * @ubi: UBI device description object
  497. */
  498. static void free_internal_volumes(struct ubi_device *ubi)
  499. {
  500. int i;
  501. for (i = ubi->vtbl_slots;
  502. i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
  503. kfree(ubi->volumes[i]->eba_tbl);
  504. kfree(ubi->volumes[i]);
  505. }
  506. }
  507. /**
  508. * attach_by_scanning - attach an MTD device using scanning method.
  509. * @ubi: UBI device descriptor
  510. *
  511. * This function returns zero in case of success and a negative error code in
  512. * case of failure.
  513. *
  514. * Note, currently this is the only method to attach UBI devices. Hopefully in
  515. * the future we'll have more scalable attaching methods and avoid full media
  516. * scanning. But even in this case scanning will be needed as a fall-back
  517. * attaching method if there are some on-flash table corruptions.
  518. */
  519. static int attach_by_scanning(struct ubi_device *ubi)
  520. {
  521. int err;
  522. struct ubi_scan_info *si;
  523. si = ubi_scan(ubi);
  524. if (IS_ERR(si))
  525. return PTR_ERR(si);
  526. ubi->bad_peb_count = si->bad_peb_count;
  527. ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
  528. ubi->max_ec = si->max_ec;
  529. ubi->mean_ec = si->mean_ec;
  530. ubi_msg("max. sequence number: %llu", si->max_sqnum);
  531. err = ubi_read_volume_table(ubi, si);
  532. if (err)
  533. goto out_si;
  534. err = ubi_wl_init_scan(ubi, si);
  535. if (err)
  536. goto out_vtbl;
  537. err = ubi_eba_init_scan(ubi, si);
  538. if (err)
  539. goto out_wl;
  540. ubi_scan_destroy_si(si);
  541. return 0;
  542. out_wl:
  543. ubi_wl_close(ubi);
  544. out_vtbl:
  545. free_internal_volumes(ubi);
  546. vfree(ubi->vtbl);
  547. out_si:
  548. ubi_scan_destroy_si(si);
  549. return err;
  550. }
  551. /**
  552. * io_init - initialize I/O sub-system for a given UBI device.
  553. * @ubi: UBI device description object
  554. *
  555. * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
  556. * assumed:
  557. * o EC header is always at offset zero - this cannot be changed;
  558. * o VID header starts just after the EC header at the closest address
  559. * aligned to @io->hdrs_min_io_size;
  560. * o data starts just after the VID header at the closest address aligned to
  561. * @io->min_io_size
  562. *
  563. * This function returns zero in case of success and a negative error code in
  564. * case of failure.
  565. */
  566. static int io_init(struct ubi_device *ubi)
  567. {
  568. if (ubi->mtd->numeraseregions != 0) {
  569. /*
  570. * Some flashes have several erase regions. Different regions
  571. * may have different eraseblock size and other
  572. * characteristics. It looks like mostly multi-region flashes
  573. * have one "main" region and one or more small regions to
  574. * store boot loader code or boot parameters or whatever. I
  575. * guess we should just pick the largest region. But this is
  576. * not implemented.
  577. */
  578. ubi_err("multiple regions, not implemented");
  579. return -EINVAL;
  580. }
  581. if (ubi->vid_hdr_offset < 0)
  582. return -EINVAL;
  583. /*
  584. * Note, in this implementation we support MTD devices with 0x7FFFFFFF
  585. * physical eraseblocks maximum.
  586. */
  587. ubi->peb_size = ubi->mtd->erasesize;
  588. ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
  589. ubi->flash_size = ubi->mtd->size;
  590. if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
  591. ubi->bad_allowed = 1;
  592. if (ubi->mtd->type == MTD_NORFLASH) {
  593. ubi_assert(ubi->mtd->writesize == 1);
  594. ubi->nor_flash = 1;
  595. }
  596. ubi->min_io_size = ubi->mtd->writesize;
  597. ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
  598. /*
  599. * Make sure minimal I/O unit is power of 2. Note, there is no
  600. * fundamental reason for this assumption. It is just an optimization
  601. * which allows us to avoid costly division operations.
  602. */
  603. if (!is_power_of_2(ubi->min_io_size)) {
  604. ubi_err("min. I/O unit (%d) is not power of 2",
  605. ubi->min_io_size);
  606. return -EINVAL;
  607. }
  608. ubi_assert(ubi->hdrs_min_io_size > 0);
  609. ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
  610. ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
  611. /* Calculate default aligned sizes of EC and VID headers */
  612. ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
  613. ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
  614. dbg_msg("min_io_size %d", ubi->min_io_size);
  615. dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
  616. dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
  617. dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
  618. if (ubi->vid_hdr_offset == 0)
  619. /* Default offset */
  620. ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
  621. ubi->ec_hdr_alsize;
  622. else {
  623. ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
  624. ~(ubi->hdrs_min_io_size - 1);
  625. ubi->vid_hdr_shift = ubi->vid_hdr_offset -
  626. ubi->vid_hdr_aloffset;
  627. }
  628. /* Similar for the data offset */
  629. ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
  630. ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
  631. dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
  632. dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
  633. dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
  634. dbg_msg("leb_start %d", ubi->leb_start);
  635. /* The shift must be aligned to 32-bit boundary */
  636. if (ubi->vid_hdr_shift % 4) {
  637. ubi_err("unaligned VID header shift %d",
  638. ubi->vid_hdr_shift);
  639. return -EINVAL;
  640. }
  641. /* Check sanity */
  642. if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
  643. ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
  644. ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
  645. ubi->leb_start & (ubi->min_io_size - 1)) {
  646. ubi_err("bad VID header (%d) or data offsets (%d)",
  647. ubi->vid_hdr_offset, ubi->leb_start);
  648. return -EINVAL;
  649. }
  650. /*
  651. * Set maximum amount of physical erroneous eraseblocks to be 10%.
  652. * Erroneous PEB are those which have read errors.
  653. */
  654. ubi->max_erroneous = ubi->peb_count / 10;
  655. if (ubi->max_erroneous < 16)
  656. ubi->max_erroneous = 16;
  657. dbg_msg("max_erroneous %d", ubi->max_erroneous);
  658. /*
  659. * It may happen that EC and VID headers are situated in one minimal
  660. * I/O unit. In this case we can only accept this UBI image in
  661. * read-only mode.
  662. */
  663. if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
  664. ubi_warn("EC and VID headers are in the same minimal I/O unit, "
  665. "switch to read-only mode");
  666. ubi->ro_mode = 1;
  667. }
  668. ubi->leb_size = ubi->peb_size - ubi->leb_start;
  669. if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
  670. ubi_msg("MTD device %d is write-protected, attach in "
  671. "read-only mode", ubi->mtd->index);
  672. ubi->ro_mode = 1;
  673. }
  674. ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
  675. ubi->peb_size, ubi->peb_size >> 10);
  676. ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
  677. ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
  678. if (ubi->hdrs_min_io_size != ubi->min_io_size)
  679. ubi_msg("sub-page size: %d",
  680. ubi->hdrs_min_io_size);
  681. ubi_msg("VID header offset: %d (aligned %d)",
  682. ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
  683. ubi_msg("data offset: %d", ubi->leb_start);
  684. /*
  685. * Note, ideally, we have to initialize ubi->bad_peb_count here. But
  686. * unfortunately, MTD does not provide this information. We should loop
  687. * over all physical eraseblocks and invoke mtd->block_is_bad() for
  688. * each physical eraseblock. So, we skip ubi->bad_peb_count
  689. * uninitialized and initialize it after scanning.
  690. */
  691. return 0;
  692. }
  693. /**
  694. * autoresize - re-size the volume which has the "auto-resize" flag set.
  695. * @ubi: UBI device description object
  696. * @vol_id: ID of the volume to re-size
  697. *
  698. * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
  699. * the volume table to the largest possible size. See comments in ubi-header.h
  700. * for more description of the flag. Returns zero in case of success and a
  701. * negative error code in case of failure.
  702. */
  703. static int autoresize(struct ubi_device *ubi, int vol_id)
  704. {
  705. struct ubi_volume_desc desc;
  706. struct ubi_volume *vol = ubi->volumes[vol_id];
  707. int err, old_reserved_pebs = vol->reserved_pebs;
  708. /*
  709. * Clear the auto-resize flag in the volume in-memory copy of the
  710. * volume table, and 'ubi_resize_volume()' will propagate this change
  711. * to the flash.
  712. */
  713. ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
  714. if (ubi->avail_pebs == 0) {
  715. struct ubi_vtbl_record vtbl_rec;
  716. /*
  717. * No available PEBs to re-size the volume, clear the flag on
  718. * flash and exit.
  719. */
  720. memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
  721. sizeof(struct ubi_vtbl_record));
  722. err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
  723. if (err)
  724. ubi_err("cannot clean auto-resize flag for volume %d",
  725. vol_id);
  726. } else {
  727. desc.vol = vol;
  728. err = ubi_resize_volume(&desc,
  729. old_reserved_pebs + ubi->avail_pebs);
  730. if (err)
  731. ubi_err("cannot auto-resize volume %d", vol_id);
  732. }
  733. if (err)
  734. return err;
  735. ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
  736. vol->name, old_reserved_pebs, vol->reserved_pebs);
  737. return 0;
  738. }
  739. /**
  740. * ubi_attach_mtd_dev - attach an MTD device.
  741. * @mtd: MTD device description object
  742. * @ubi_num: number to assign to the new UBI device
  743. * @vid_hdr_offset: VID header offset
  744. *
  745. * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
  746. * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
  747. * which case this function finds a vacant device number and assigns it
  748. * automatically. Returns the new UBI device number in case of success and a
  749. * negative error code in case of failure.
  750. *
  751. * Note, the invocations of this function has to be serialized by the
  752. * @ubi_devices_mutex.
  753. */
  754. int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
  755. {
  756. struct ubi_device *ubi;
  757. int i, err, ref = 0;
  758. /*
  759. * Check if we already have the same MTD device attached.
  760. *
  761. * Note, this function assumes that UBI devices creations and deletions
  762. * are serialized, so it does not take the &ubi_devices_lock.
  763. */
  764. for (i = 0; i < UBI_MAX_DEVICES; i++) {
  765. ubi = ubi_devices[i];
  766. if (ubi && mtd->index == ubi->mtd->index) {
  767. dbg_err("mtd%d is already attached to ubi%d",
  768. mtd->index, i);
  769. return -EEXIST;
  770. }
  771. }
  772. /*
  773. * Make sure this MTD device is not emulated on top of an UBI volume
  774. * already. Well, generally this recursion works fine, but there are
  775. * different problems like the UBI module takes a reference to itself
  776. * by attaching (and thus, opening) the emulated MTD device. This
  777. * results in inability to unload the module. And in general it makes
  778. * no sense to attach emulated MTD devices, so we prohibit this.
  779. */
  780. if (mtd->type == MTD_UBIVOLUME) {
  781. ubi_err("refuse attaching mtd%d - it is already emulated on "
  782. "top of UBI", mtd->index);
  783. return -EINVAL;
  784. }
  785. if (ubi_num == UBI_DEV_NUM_AUTO) {
  786. /* Search for an empty slot in the @ubi_devices array */
  787. for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
  788. if (!ubi_devices[ubi_num])
  789. break;
  790. if (ubi_num == UBI_MAX_DEVICES) {
  791. dbg_err("only %d UBI devices may be created",
  792. UBI_MAX_DEVICES);
  793. return -ENFILE;
  794. }
  795. } else {
  796. if (ubi_num >= UBI_MAX_DEVICES)
  797. return -EINVAL;
  798. /* Make sure ubi_num is not busy */
  799. if (ubi_devices[ubi_num]) {
  800. dbg_err("ubi%d already exists", ubi_num);
  801. return -EEXIST;
  802. }
  803. }
  804. ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
  805. if (!ubi)
  806. return -ENOMEM;
  807. ubi->mtd = mtd;
  808. ubi->ubi_num = ubi_num;
  809. ubi->vid_hdr_offset = vid_hdr_offset;
  810. ubi->autoresize_vol_id = -1;
  811. mutex_init(&ubi->buf_mutex);
  812. mutex_init(&ubi->ckvol_mutex);
  813. mutex_init(&ubi->device_mutex);
  814. spin_lock_init(&ubi->volumes_lock);
  815. ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
  816. err = io_init(ubi);
  817. if (err)
  818. goto out_free;
  819. err = -ENOMEM;
  820. ubi->peb_buf1 = vmalloc(ubi->peb_size);
  821. if (!ubi->peb_buf1)
  822. goto out_free;
  823. ubi->peb_buf2 = vmalloc(ubi->peb_size);
  824. if (!ubi->peb_buf2)
  825. goto out_free;
  826. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  827. mutex_init(&ubi->dbg_buf_mutex);
  828. ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
  829. if (!ubi->dbg_peb_buf)
  830. goto out_free;
  831. #endif
  832. err = attach_by_scanning(ubi);
  833. if (err) {
  834. dbg_err("failed to attach by scanning, error %d", err);
  835. goto out_free;
  836. }
  837. if (ubi->autoresize_vol_id != -1) {
  838. err = autoresize(ubi, ubi->autoresize_vol_id);
  839. if (err)
  840. goto out_detach;
  841. }
  842. err = uif_init(ubi, &ref);
  843. if (err)
  844. goto out_detach;
  845. ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
  846. if (IS_ERR(ubi->bgt_thread)) {
  847. err = PTR_ERR(ubi->bgt_thread);
  848. ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
  849. err);
  850. goto out_uif;
  851. }
  852. ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
  853. ubi_msg("MTD device name: \"%s\"", mtd->name);
  854. ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
  855. ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
  856. ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
  857. ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
  858. ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
  859. ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
  860. ubi_msg("number of user volumes: %d",
  861. ubi->vol_count - UBI_INT_VOL_COUNT);
  862. ubi_msg("available PEBs: %d", ubi->avail_pebs);
  863. ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
  864. ubi_msg("number of PEBs reserved for bad PEB handling: %d",
  865. ubi->beb_rsvd_pebs);
  866. ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
  867. ubi_msg("image sequence number: %d", ubi->image_seq);
  868. /*
  869. * The below lock makes sure we do not race with 'ubi_thread()' which
  870. * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
  871. */
  872. spin_lock(&ubi->wl_lock);
  873. if (!DBG_DISABLE_BGT)
  874. ubi->thread_enabled = 1;
  875. wake_up_process(ubi->bgt_thread);
  876. spin_unlock(&ubi->wl_lock);
  877. ubi_devices[ubi_num] = ubi;
  878. ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
  879. return ubi_num;
  880. out_uif:
  881. uif_close(ubi);
  882. out_detach:
  883. ubi_wl_close(ubi);
  884. free_internal_volumes(ubi);
  885. vfree(ubi->vtbl);
  886. out_free:
  887. vfree(ubi->peb_buf1);
  888. vfree(ubi->peb_buf2);
  889. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  890. vfree(ubi->dbg_peb_buf);
  891. #endif
  892. if (ref)
  893. put_device(&ubi->dev);
  894. else
  895. kfree(ubi);
  896. return err;
  897. }
  898. /**
  899. * ubi_detach_mtd_dev - detach an MTD device.
  900. * @ubi_num: UBI device number to detach from
  901. * @anyway: detach MTD even if device reference count is not zero
  902. *
  903. * This function destroys an UBI device number @ubi_num and detaches the
  904. * underlying MTD device. Returns zero in case of success and %-EBUSY if the
  905. * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
  906. * exist.
  907. *
  908. * Note, the invocations of this function has to be serialized by the
  909. * @ubi_devices_mutex.
  910. */
  911. int ubi_detach_mtd_dev(int ubi_num, int anyway)
  912. {
  913. struct ubi_device *ubi;
  914. if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
  915. return -EINVAL;
  916. ubi = ubi_get_device(ubi_num);
  917. if (!ubi)
  918. return -EINVAL;
  919. spin_lock(&ubi_devices_lock);
  920. put_device(&ubi->dev);
  921. ubi->ref_count -= 1;
  922. if (ubi->ref_count) {
  923. if (!anyway) {
  924. spin_unlock(&ubi_devices_lock);
  925. return -EBUSY;
  926. }
  927. /* This may only happen if there is a bug */
  928. ubi_err("%s reference count %d, destroy anyway",
  929. ubi->ubi_name, ubi->ref_count);
  930. }
  931. ubi_devices[ubi_num] = NULL;
  932. spin_unlock(&ubi_devices_lock);
  933. ubi_assert(ubi_num == ubi->ubi_num);
  934. ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
  935. dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
  936. /*
  937. * Before freeing anything, we have to stop the background thread to
  938. * prevent it from doing anything on this device while we are freeing.
  939. */
  940. if (ubi->bgt_thread)
  941. kthread_stop(ubi->bgt_thread);
  942. /*
  943. * Get a reference to the device in order to prevent 'dev_release()'
  944. * from freeing the @ubi object.
  945. */
  946. get_device(&ubi->dev);
  947. uif_close(ubi);
  948. ubi_wl_close(ubi);
  949. free_internal_volumes(ubi);
  950. vfree(ubi->vtbl);
  951. put_mtd_device(ubi->mtd);
  952. vfree(ubi->peb_buf1);
  953. vfree(ubi->peb_buf2);
  954. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  955. vfree(ubi->dbg_peb_buf);
  956. #endif
  957. ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
  958. put_device(&ubi->dev);
  959. return 0;
  960. }
  961. /**
  962. * open_mtd_by_chdev - open an MTD device by its character device node path.
  963. * @mtd_dev: MTD character device node path
  964. *
  965. * This helper function opens an MTD device by its character node device path.
  966. * Returns MTD device description object in case of success and a negative
  967. * error code in case of failure.
  968. */
  969. static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
  970. {
  971. int err, major, minor, mode;
  972. struct path path;
  973. /* Probably this is an MTD character device node path */
  974. err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
  975. if (err)
  976. return ERR_PTR(err);
  977. /* MTD device number is defined by the major / minor numbers */
  978. major = imajor(path.dentry->d_inode);
  979. minor = iminor(path.dentry->d_inode);
  980. mode = path.dentry->d_inode->i_mode;
  981. path_put(&path);
  982. if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
  983. return ERR_PTR(-EINVAL);
  984. if (minor & 1)
  985. /*
  986. * Just do not think the "/dev/mtdrX" devices support is need,
  987. * so do not support them to avoid doing extra work.
  988. */
  989. return ERR_PTR(-EINVAL);
  990. return get_mtd_device(NULL, minor / 2);
  991. }
  992. /**
  993. * open_mtd_device - open MTD device by name, character device path, or number.
  994. * @mtd_dev: name, character device node path, or MTD device device number
  995. *
  996. * This function tries to open and MTD device described by @mtd_dev string,
  997. * which is first treated as ASCII MTD device number, and if it is not true, it
  998. * is treated as MTD device name, and if that is also not true, it is treated
  999. * as MTD character device node path. Returns MTD device description object in
  1000. * case of success and a negative error code in case of failure.
  1001. */
  1002. static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
  1003. {
  1004. struct mtd_info *mtd;
  1005. int mtd_num;
  1006. char *endp;
  1007. mtd_num = simple_strtoul(mtd_dev, &endp, 0);
  1008. if (*endp != '\0' || mtd_dev == endp) {
  1009. /*
  1010. * This does not look like an ASCII integer, probably this is
  1011. * MTD device name.
  1012. */
  1013. mtd = get_mtd_device_nm(mtd_dev);
  1014. if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
  1015. /* Probably this is an MTD character device node path */
  1016. mtd = open_mtd_by_chdev(mtd_dev);
  1017. } else
  1018. mtd = get_mtd_device(NULL, mtd_num);
  1019. return mtd;
  1020. }
  1021. static int __init ubi_init(void)
  1022. {
  1023. int err, i, k;
  1024. /* Ensure that EC and VID headers have correct size */
  1025. BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
  1026. BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
  1027. if (mtd_devs > UBI_MAX_DEVICES) {
  1028. ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
  1029. return -EINVAL;
  1030. }
  1031. /* Create base sysfs directory and sysfs files */
  1032. ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
  1033. if (IS_ERR(ubi_class)) {
  1034. err = PTR_ERR(ubi_class);
  1035. ubi_err("cannot create UBI class");
  1036. goto out;
  1037. }
  1038. err = class_create_file(ubi_class, &ubi_version);
  1039. if (err) {
  1040. ubi_err("cannot create sysfs file");
  1041. goto out_class;
  1042. }
  1043. err = misc_register(&ubi_ctrl_cdev);
  1044. if (err) {
  1045. ubi_err("cannot register device");
  1046. goto out_version;
  1047. }
  1048. ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
  1049. sizeof(struct ubi_wl_entry),
  1050. 0, 0, NULL);
  1051. if (!ubi_wl_entry_slab)
  1052. goto out_dev_unreg;
  1053. /* Attach MTD devices */
  1054. for (i = 0; i < mtd_devs; i++) {
  1055. struct mtd_dev_param *p = &mtd_dev_param[i];
  1056. struct mtd_info *mtd;
  1057. cond_resched();
  1058. mtd = open_mtd_device(p->name);
  1059. if (IS_ERR(mtd)) {
  1060. err = PTR_ERR(mtd);
  1061. goto out_detach;
  1062. }
  1063. mutex_lock(&ubi_devices_mutex);
  1064. err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
  1065. p->vid_hdr_offs);
  1066. mutex_unlock(&ubi_devices_mutex);
  1067. if (err < 0) {
  1068. ubi_err("cannot attach mtd%d", mtd->index);
  1069. put_mtd_device(mtd);
  1070. /*
  1071. * Originally UBI stopped initializing on any error.
  1072. * However, later on it was found out that this
  1073. * behavior is not very good when UBI is compiled into
  1074. * the kernel and the MTD devices to attach are passed
  1075. * through the command line. Indeed, UBI failure
  1076. * stopped whole boot sequence.
  1077. *
  1078. * To fix this, we changed the behavior for the
  1079. * non-module case, but preserved the old behavior for
  1080. * the module case, just for compatibility. This is a
  1081. * little inconsistent, though.
  1082. */
  1083. if (ubi_is_module())
  1084. goto out_detach;
  1085. }
  1086. }
  1087. return 0;
  1088. out_detach:
  1089. for (k = 0; k < i; k++)
  1090. if (ubi_devices[k]) {
  1091. mutex_lock(&ubi_devices_mutex);
  1092. ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
  1093. mutex_unlock(&ubi_devices_mutex);
  1094. }
  1095. kmem_cache_destroy(ubi_wl_entry_slab);
  1096. out_dev_unreg:
  1097. misc_deregister(&ubi_ctrl_cdev);
  1098. out_version:
  1099. class_remove_file(ubi_class, &ubi_version);
  1100. out_class:
  1101. class_destroy(ubi_class);
  1102. out:
  1103. ubi_err("UBI error: cannot initialize UBI, error %d", err);
  1104. return err;
  1105. }
  1106. module_init(ubi_init);
  1107. static void __exit ubi_exit(void)
  1108. {
  1109. int i;
  1110. for (i = 0; i < UBI_MAX_DEVICES; i++)
  1111. if (ubi_devices[i]) {
  1112. mutex_lock(&ubi_devices_mutex);
  1113. ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
  1114. mutex_unlock(&ubi_devices_mutex);
  1115. }
  1116. kmem_cache_destroy(ubi_wl_entry_slab);
  1117. misc_deregister(&ubi_ctrl_cdev);
  1118. class_remove_file(ubi_class, &ubi_version);
  1119. class_destroy(ubi_class);
  1120. }
  1121. module_exit(ubi_exit);
  1122. /**
  1123. * bytes_str_to_int - convert a number of bytes string into an integer.
  1124. * @str: the string to convert
  1125. *
  1126. * This function returns positive resulting integer in case of success and a
  1127. * negative error code in case of failure.
  1128. */
  1129. static int __init bytes_str_to_int(const char *str)
  1130. {
  1131. char *endp;
  1132. unsigned long result;
  1133. result = simple_strtoul(str, &endp, 0);
  1134. if (str == endp || result >= INT_MAX) {
  1135. printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
  1136. str);
  1137. return -EINVAL;
  1138. }
  1139. switch (*endp) {
  1140. case 'G':
  1141. result *= 1024;
  1142. case 'M':
  1143. result *= 1024;
  1144. case 'K':
  1145. result *= 1024;
  1146. if (endp[1] == 'i' && endp[2] == 'B')
  1147. endp += 2;
  1148. case '\0':
  1149. break;
  1150. default:
  1151. printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
  1152. str);
  1153. return -EINVAL;
  1154. }
  1155. return result;
  1156. }
  1157. /**
  1158. * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
  1159. * @val: the parameter value to parse
  1160. * @kp: not used
  1161. *
  1162. * This function returns zero in case of success and a negative error code in
  1163. * case of error.
  1164. */
  1165. static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
  1166. {
  1167. int i, len;
  1168. struct mtd_dev_param *p;
  1169. char buf[MTD_PARAM_LEN_MAX];
  1170. char *pbuf = &buf[0];
  1171. char *tokens[2] = {NULL, NULL};
  1172. if (!val)
  1173. return -EINVAL;
  1174. if (mtd_devs == UBI_MAX_DEVICES) {
  1175. printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
  1176. UBI_MAX_DEVICES);
  1177. return -EINVAL;
  1178. }
  1179. len = strnlen(val, MTD_PARAM_LEN_MAX);
  1180. if (len == MTD_PARAM_LEN_MAX) {
  1181. printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
  1182. "max. is %d\n", val, MTD_PARAM_LEN_MAX);
  1183. return -EINVAL;
  1184. }
  1185. if (len == 0) {
  1186. printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
  1187. "ignored\n");
  1188. return 0;
  1189. }
  1190. strcpy(buf, val);
  1191. /* Get rid of the final newline */
  1192. if (buf[len - 1] == '\n')
  1193. buf[len - 1] = '\0';
  1194. for (i = 0; i < 2; i++)
  1195. tokens[i] = strsep(&pbuf, ",");
  1196. if (pbuf) {
  1197. printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
  1198. val);
  1199. return -EINVAL;
  1200. }
  1201. p = &mtd_dev_param[mtd_devs];
  1202. strcpy(&p->name[0], tokens[0]);
  1203. if (tokens[1])
  1204. p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
  1205. if (p->vid_hdr_offs < 0)
  1206. return p->vid_hdr_offs;
  1207. mtd_devs += 1;
  1208. return 0;
  1209. }
  1210. module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
  1211. MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
  1212. "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
  1213. "Multiple \"mtd\" parameters may be specified.\n"
  1214. "MTD devices may be specified by their number, name, or "
  1215. "path to the MTD character device node.\n"
  1216. "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
  1217. "header position to be used by UBI.\n"
  1218. "Example 1: mtd=/dev/mtd0 - attach MTD device "
  1219. "/dev/mtd0.\n"
  1220. "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
  1221. "with name \"content\" using VID header offset 1984, and "
  1222. "MTD device number 4 with default VID header offset.");
  1223. MODULE_VERSION(__stringify(UBI_VERSION));
  1224. MODULE_DESCRIPTION("UBI - Unsorted Block Images");
  1225. MODULE_AUTHOR("Artem Bityutskiy");
  1226. MODULE_LICENSE("GPL");