build.c 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397
  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. err = ubi_read_volume_table(ubi, si);
  531. if (err)
  532. goto out_si;
  533. err = ubi_wl_init_scan(ubi, si);
  534. if (err)
  535. goto out_vtbl;
  536. err = ubi_eba_init_scan(ubi, si);
  537. if (err)
  538. goto out_wl;
  539. ubi_scan_destroy_si(si);
  540. return 0;
  541. out_wl:
  542. ubi_wl_close(ubi);
  543. out_vtbl:
  544. free_internal_volumes(ubi);
  545. vfree(ubi->vtbl);
  546. out_si:
  547. ubi_scan_destroy_si(si);
  548. return err;
  549. }
  550. /**
  551. * io_init - initialize I/O sub-system for a given UBI device.
  552. * @ubi: UBI device description object
  553. *
  554. * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
  555. * assumed:
  556. * o EC header is always at offset zero - this cannot be changed;
  557. * o VID header starts just after the EC header at the closest address
  558. * aligned to @io->hdrs_min_io_size;
  559. * o data starts just after the VID header at the closest address aligned to
  560. * @io->min_io_size
  561. *
  562. * This function returns zero in case of success and a negative error code in
  563. * case of failure.
  564. */
  565. static int io_init(struct ubi_device *ubi)
  566. {
  567. if (ubi->mtd->numeraseregions != 0) {
  568. /*
  569. * Some flashes have several erase regions. Different regions
  570. * may have different eraseblock size and other
  571. * characteristics. It looks like mostly multi-region flashes
  572. * have one "main" region and one or more small regions to
  573. * store boot loader code or boot parameters or whatever. I
  574. * guess we should just pick the largest region. But this is
  575. * not implemented.
  576. */
  577. ubi_err("multiple regions, not implemented");
  578. return -EINVAL;
  579. }
  580. if (ubi->vid_hdr_offset < 0)
  581. return -EINVAL;
  582. /*
  583. * Note, in this implementation we support MTD devices with 0x7FFFFFFF
  584. * physical eraseblocks maximum.
  585. */
  586. ubi->peb_size = ubi->mtd->erasesize;
  587. ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
  588. ubi->flash_size = ubi->mtd->size;
  589. if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
  590. ubi->bad_allowed = 1;
  591. if (ubi->mtd->type == MTD_NORFLASH) {
  592. ubi_assert(ubi->mtd->writesize == 1);
  593. ubi->nor_flash = 1;
  594. }
  595. ubi->min_io_size = ubi->mtd->writesize;
  596. ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
  597. /*
  598. * Make sure minimal I/O unit is power of 2. Note, there is no
  599. * fundamental reason for this assumption. It is just an optimization
  600. * which allows us to avoid costly division operations.
  601. */
  602. if (!is_power_of_2(ubi->min_io_size)) {
  603. ubi_err("min. I/O unit (%d) is not power of 2",
  604. ubi->min_io_size);
  605. return -EINVAL;
  606. }
  607. ubi_assert(ubi->hdrs_min_io_size > 0);
  608. ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
  609. ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
  610. /* Calculate default aligned sizes of EC and VID headers */
  611. ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
  612. ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
  613. dbg_msg("min_io_size %d", ubi->min_io_size);
  614. dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
  615. dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
  616. dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
  617. if (ubi->vid_hdr_offset == 0)
  618. /* Default offset */
  619. ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
  620. ubi->ec_hdr_alsize;
  621. else {
  622. ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
  623. ~(ubi->hdrs_min_io_size - 1);
  624. ubi->vid_hdr_shift = ubi->vid_hdr_offset -
  625. ubi->vid_hdr_aloffset;
  626. }
  627. /* Similar for the data offset */
  628. ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
  629. ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
  630. dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
  631. dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
  632. dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
  633. dbg_msg("leb_start %d", ubi->leb_start);
  634. /* The shift must be aligned to 32-bit boundary */
  635. if (ubi->vid_hdr_shift % 4) {
  636. ubi_err("unaligned VID header shift %d",
  637. ubi->vid_hdr_shift);
  638. return -EINVAL;
  639. }
  640. /* Check sanity */
  641. if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
  642. ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
  643. ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
  644. ubi->leb_start & (ubi->min_io_size - 1)) {
  645. ubi_err("bad VID header (%d) or data offsets (%d)",
  646. ubi->vid_hdr_offset, ubi->leb_start);
  647. return -EINVAL;
  648. }
  649. /*
  650. * Set maximum amount of physical erroneous eraseblocks to be 10%.
  651. * Erroneous PEB are those which have read errors.
  652. */
  653. ubi->max_erroneous = ubi->peb_count / 10;
  654. if (ubi->max_erroneous < 16)
  655. ubi->max_erroneous = 16;
  656. dbg_msg("max_erroneous %d", ubi->max_erroneous);
  657. /*
  658. * It may happen that EC and VID headers are situated in one minimal
  659. * I/O unit. In this case we can only accept this UBI image in
  660. * read-only mode.
  661. */
  662. if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
  663. ubi_warn("EC and VID headers are in the same minimal I/O unit, "
  664. "switch to read-only mode");
  665. ubi->ro_mode = 1;
  666. }
  667. ubi->leb_size = ubi->peb_size - ubi->leb_start;
  668. if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
  669. ubi_msg("MTD device %d is write-protected, attach in "
  670. "read-only mode", ubi->mtd->index);
  671. ubi->ro_mode = 1;
  672. }
  673. ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
  674. ubi->peb_size, ubi->peb_size >> 10);
  675. ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
  676. ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
  677. if (ubi->hdrs_min_io_size != ubi->min_io_size)
  678. ubi_msg("sub-page size: %d",
  679. ubi->hdrs_min_io_size);
  680. ubi_msg("VID header offset: %d (aligned %d)",
  681. ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
  682. ubi_msg("data offset: %d", ubi->leb_start);
  683. /*
  684. * Note, ideally, we have to initialize ubi->bad_peb_count here. But
  685. * unfortunately, MTD does not provide this information. We should loop
  686. * over all physical eraseblocks and invoke mtd->block_is_bad() for
  687. * each physical eraseblock. So, we skip ubi->bad_peb_count
  688. * uninitialized and initialize it after scanning.
  689. */
  690. return 0;
  691. }
  692. /**
  693. * autoresize - re-size the volume which has the "auto-resize" flag set.
  694. * @ubi: UBI device description object
  695. * @vol_id: ID of the volume to re-size
  696. *
  697. * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
  698. * the volume table to the largest possible size. See comments in ubi-header.h
  699. * for more description of the flag. Returns zero in case of success and a
  700. * negative error code in case of failure.
  701. */
  702. static int autoresize(struct ubi_device *ubi, int vol_id)
  703. {
  704. struct ubi_volume_desc desc;
  705. struct ubi_volume *vol = ubi->volumes[vol_id];
  706. int err, old_reserved_pebs = vol->reserved_pebs;
  707. /*
  708. * Clear the auto-resize flag in the volume in-memory copy of the
  709. * volume table, and 'ubi_resize_volume()' will propagate this change
  710. * to the flash.
  711. */
  712. ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
  713. if (ubi->avail_pebs == 0) {
  714. struct ubi_vtbl_record vtbl_rec;
  715. /*
  716. * No available PEBs to re-size the volume, clear the flag on
  717. * flash and exit.
  718. */
  719. memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
  720. sizeof(struct ubi_vtbl_record));
  721. err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
  722. if (err)
  723. ubi_err("cannot clean auto-resize flag for volume %d",
  724. vol_id);
  725. } else {
  726. desc.vol = vol;
  727. err = ubi_resize_volume(&desc,
  728. old_reserved_pebs + ubi->avail_pebs);
  729. if (err)
  730. ubi_err("cannot auto-resize volume %d", vol_id);
  731. }
  732. if (err)
  733. return err;
  734. ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
  735. vol->name, old_reserved_pebs, vol->reserved_pebs);
  736. return 0;
  737. }
  738. /**
  739. * ubi_attach_mtd_dev - attach an MTD device.
  740. * @mtd: MTD device description object
  741. * @ubi_num: number to assign to the new UBI device
  742. * @vid_hdr_offset: VID header offset
  743. *
  744. * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
  745. * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
  746. * which case this function finds a vacant device number and assigns it
  747. * automatically. Returns the new UBI device number in case of success and a
  748. * negative error code in case of failure.
  749. *
  750. * Note, the invocations of this function has to be serialized by the
  751. * @ubi_devices_mutex.
  752. */
  753. int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
  754. {
  755. struct ubi_device *ubi;
  756. int i, err, ref = 0;
  757. /*
  758. * Check if we already have the same MTD device attached.
  759. *
  760. * Note, this function assumes that UBI devices creations and deletions
  761. * are serialized, so it does not take the &ubi_devices_lock.
  762. */
  763. for (i = 0; i < UBI_MAX_DEVICES; i++) {
  764. ubi = ubi_devices[i];
  765. if (ubi && mtd->index == ubi->mtd->index) {
  766. dbg_err("mtd%d is already attached to ubi%d",
  767. mtd->index, i);
  768. return -EEXIST;
  769. }
  770. }
  771. /*
  772. * Make sure this MTD device is not emulated on top of an UBI volume
  773. * already. Well, generally this recursion works fine, but there are
  774. * different problems like the UBI module takes a reference to itself
  775. * by attaching (and thus, opening) the emulated MTD device. This
  776. * results in inability to unload the module. And in general it makes
  777. * no sense to attach emulated MTD devices, so we prohibit this.
  778. */
  779. if (mtd->type == MTD_UBIVOLUME) {
  780. ubi_err("refuse attaching mtd%d - it is already emulated on "
  781. "top of UBI", mtd->index);
  782. return -EINVAL;
  783. }
  784. if (ubi_num == UBI_DEV_NUM_AUTO) {
  785. /* Search for an empty slot in the @ubi_devices array */
  786. for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
  787. if (!ubi_devices[ubi_num])
  788. break;
  789. if (ubi_num == UBI_MAX_DEVICES) {
  790. dbg_err("only %d UBI devices may be created",
  791. UBI_MAX_DEVICES);
  792. return -ENFILE;
  793. }
  794. } else {
  795. if (ubi_num >= UBI_MAX_DEVICES)
  796. return -EINVAL;
  797. /* Make sure ubi_num is not busy */
  798. if (ubi_devices[ubi_num]) {
  799. dbg_err("ubi%d already exists", ubi_num);
  800. return -EEXIST;
  801. }
  802. }
  803. ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
  804. if (!ubi)
  805. return -ENOMEM;
  806. ubi->mtd = mtd;
  807. ubi->ubi_num = ubi_num;
  808. ubi->vid_hdr_offset = vid_hdr_offset;
  809. ubi->autoresize_vol_id = -1;
  810. mutex_init(&ubi->buf_mutex);
  811. mutex_init(&ubi->ckvol_mutex);
  812. mutex_init(&ubi->device_mutex);
  813. spin_lock_init(&ubi->volumes_lock);
  814. ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
  815. err = io_init(ubi);
  816. if (err)
  817. goto out_free;
  818. err = -ENOMEM;
  819. ubi->peb_buf1 = vmalloc(ubi->peb_size);
  820. if (!ubi->peb_buf1)
  821. goto out_free;
  822. ubi->peb_buf2 = vmalloc(ubi->peb_size);
  823. if (!ubi->peb_buf2)
  824. goto out_free;
  825. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  826. mutex_init(&ubi->dbg_buf_mutex);
  827. ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
  828. if (!ubi->dbg_peb_buf)
  829. goto out_free;
  830. #endif
  831. err = attach_by_scanning(ubi);
  832. if (err) {
  833. dbg_err("failed to attach by scanning, error %d", err);
  834. goto out_free;
  835. }
  836. if (ubi->autoresize_vol_id != -1) {
  837. err = autoresize(ubi, ubi->autoresize_vol_id);
  838. if (err)
  839. goto out_detach;
  840. }
  841. err = uif_init(ubi, &ref);
  842. if (err)
  843. goto out_detach;
  844. ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
  845. if (IS_ERR(ubi->bgt_thread)) {
  846. err = PTR_ERR(ubi->bgt_thread);
  847. ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
  848. err);
  849. goto out_uif;
  850. }
  851. ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
  852. ubi_msg("MTD device name: \"%s\"", mtd->name);
  853. ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
  854. ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
  855. ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
  856. ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
  857. ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
  858. ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
  859. ubi_msg("number of user volumes: %d",
  860. ubi->vol_count - UBI_INT_VOL_COUNT);
  861. ubi_msg("available PEBs: %d", ubi->avail_pebs);
  862. ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
  863. ubi_msg("number of PEBs reserved for bad PEB handling: %d",
  864. ubi->beb_rsvd_pebs);
  865. ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
  866. ubi_msg("image sequence number: %d", ubi->image_seq);
  867. /*
  868. * The below lock makes sure we do not race with 'ubi_thread()' which
  869. * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
  870. */
  871. spin_lock(&ubi->wl_lock);
  872. if (!DBG_DISABLE_BGT)
  873. ubi->thread_enabled = 1;
  874. wake_up_process(ubi->bgt_thread);
  875. spin_unlock(&ubi->wl_lock);
  876. ubi_devices[ubi_num] = ubi;
  877. ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
  878. return ubi_num;
  879. out_uif:
  880. uif_close(ubi);
  881. out_detach:
  882. ubi_wl_close(ubi);
  883. free_internal_volumes(ubi);
  884. vfree(ubi->vtbl);
  885. out_free:
  886. vfree(ubi->peb_buf1);
  887. vfree(ubi->peb_buf2);
  888. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  889. vfree(ubi->dbg_peb_buf);
  890. #endif
  891. if (ref)
  892. put_device(&ubi->dev);
  893. else
  894. kfree(ubi);
  895. return err;
  896. }
  897. /**
  898. * ubi_detach_mtd_dev - detach an MTD device.
  899. * @ubi_num: UBI device number to detach from
  900. * @anyway: detach MTD even if device reference count is not zero
  901. *
  902. * This function destroys an UBI device number @ubi_num and detaches the
  903. * underlying MTD device. Returns zero in case of success and %-EBUSY if the
  904. * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
  905. * exist.
  906. *
  907. * Note, the invocations of this function has to be serialized by the
  908. * @ubi_devices_mutex.
  909. */
  910. int ubi_detach_mtd_dev(int ubi_num, int anyway)
  911. {
  912. struct ubi_device *ubi;
  913. if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
  914. return -EINVAL;
  915. ubi = ubi_get_device(ubi_num);
  916. if (!ubi)
  917. return -EINVAL;
  918. spin_lock(&ubi_devices_lock);
  919. put_device(&ubi->dev);
  920. ubi->ref_count -= 1;
  921. if (ubi->ref_count) {
  922. if (!anyway) {
  923. spin_unlock(&ubi_devices_lock);
  924. return -EBUSY;
  925. }
  926. /* This may only happen if there is a bug */
  927. ubi_err("%s reference count %d, destroy anyway",
  928. ubi->ubi_name, ubi->ref_count);
  929. }
  930. ubi_devices[ubi_num] = NULL;
  931. spin_unlock(&ubi_devices_lock);
  932. ubi_assert(ubi_num == ubi->ubi_num);
  933. ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
  934. dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
  935. /*
  936. * Before freeing anything, we have to stop the background thread to
  937. * prevent it from doing anything on this device while we are freeing.
  938. */
  939. if (ubi->bgt_thread)
  940. kthread_stop(ubi->bgt_thread);
  941. /*
  942. * Get a reference to the device in order to prevent 'dev_release()'
  943. * from freeing the @ubi object.
  944. */
  945. get_device(&ubi->dev);
  946. uif_close(ubi);
  947. ubi_wl_close(ubi);
  948. free_internal_volumes(ubi);
  949. vfree(ubi->vtbl);
  950. put_mtd_device(ubi->mtd);
  951. vfree(ubi->peb_buf1);
  952. vfree(ubi->peb_buf2);
  953. #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
  954. vfree(ubi->dbg_peb_buf);
  955. #endif
  956. ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
  957. put_device(&ubi->dev);
  958. return 0;
  959. }
  960. /**
  961. * open_mtd_by_chdev - open an MTD device by its character device node path.
  962. * @mtd_dev: MTD character device node path
  963. *
  964. * This helper function opens an MTD device by its character node device path.
  965. * Returns MTD device description object in case of success and a negative
  966. * error code in case of failure.
  967. */
  968. static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
  969. {
  970. int err, major, minor, mode;
  971. struct path path;
  972. /* Probably this is an MTD character device node path */
  973. err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
  974. if (err)
  975. return ERR_PTR(err);
  976. /* MTD device number is defined by the major / minor numbers */
  977. major = imajor(path.dentry->d_inode);
  978. minor = iminor(path.dentry->d_inode);
  979. mode = path.dentry->d_inode->i_mode;
  980. path_put(&path);
  981. if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
  982. return ERR_PTR(-EINVAL);
  983. if (minor & 1)
  984. /*
  985. * Just do not think the "/dev/mtdrX" devices support is need,
  986. * so do not support them to avoid doing extra work.
  987. */
  988. return ERR_PTR(-EINVAL);
  989. return get_mtd_device(NULL, minor / 2);
  990. }
  991. /**
  992. * open_mtd_device - open MTD device by name, character device path, or number.
  993. * @mtd_dev: name, character device node path, or MTD device device number
  994. *
  995. * This function tries to open and MTD device described by @mtd_dev string,
  996. * which is first treated as ASCII MTD device number, and if it is not true, it
  997. * is treated as MTD device name, and if that is also not true, it is treated
  998. * as MTD character device node path. Returns MTD device description object in
  999. * case of success and a negative error code in case of failure.
  1000. */
  1001. static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
  1002. {
  1003. struct mtd_info *mtd;
  1004. int mtd_num;
  1005. char *endp;
  1006. mtd_num = simple_strtoul(mtd_dev, &endp, 0);
  1007. if (*endp != '\0' || mtd_dev == endp) {
  1008. /*
  1009. * This does not look like an ASCII integer, probably this is
  1010. * MTD device name.
  1011. */
  1012. mtd = get_mtd_device_nm(mtd_dev);
  1013. if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
  1014. /* Probably this is an MTD character device node path */
  1015. mtd = open_mtd_by_chdev(mtd_dev);
  1016. } else
  1017. mtd = get_mtd_device(NULL, mtd_num);
  1018. return mtd;
  1019. }
  1020. static int __init ubi_init(void)
  1021. {
  1022. int err, i, k;
  1023. /* Ensure that EC and VID headers have correct size */
  1024. BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
  1025. BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
  1026. if (mtd_devs > UBI_MAX_DEVICES) {
  1027. ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
  1028. return -EINVAL;
  1029. }
  1030. /* Create base sysfs directory and sysfs files */
  1031. ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
  1032. if (IS_ERR(ubi_class)) {
  1033. err = PTR_ERR(ubi_class);
  1034. ubi_err("cannot create UBI class");
  1035. goto out;
  1036. }
  1037. err = class_create_file(ubi_class, &ubi_version);
  1038. if (err) {
  1039. ubi_err("cannot create sysfs file");
  1040. goto out_class;
  1041. }
  1042. err = misc_register(&ubi_ctrl_cdev);
  1043. if (err) {
  1044. ubi_err("cannot register device");
  1045. goto out_version;
  1046. }
  1047. ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
  1048. sizeof(struct ubi_wl_entry),
  1049. 0, 0, NULL);
  1050. if (!ubi_wl_entry_slab)
  1051. goto out_dev_unreg;
  1052. /* Attach MTD devices */
  1053. for (i = 0; i < mtd_devs; i++) {
  1054. struct mtd_dev_param *p = &mtd_dev_param[i];
  1055. struct mtd_info *mtd;
  1056. cond_resched();
  1057. mtd = open_mtd_device(p->name);
  1058. if (IS_ERR(mtd)) {
  1059. err = PTR_ERR(mtd);
  1060. goto out_detach;
  1061. }
  1062. mutex_lock(&ubi_devices_mutex);
  1063. err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
  1064. p->vid_hdr_offs);
  1065. mutex_unlock(&ubi_devices_mutex);
  1066. if (err < 0) {
  1067. ubi_err("cannot attach mtd%d", mtd->index);
  1068. put_mtd_device(mtd);
  1069. /*
  1070. * Originally UBI stopped initializing on any error.
  1071. * However, later on it was found out that this
  1072. * behavior is not very good when UBI is compiled into
  1073. * the kernel and the MTD devices to attach are passed
  1074. * through the command line. Indeed, UBI failure
  1075. * stopped whole boot sequence.
  1076. *
  1077. * To fix this, we changed the behavior for the
  1078. * non-module case, but preserved the old behavior for
  1079. * the module case, just for compatibility. This is a
  1080. * little inconsistent, though.
  1081. */
  1082. if (ubi_is_module())
  1083. goto out_detach;
  1084. }
  1085. }
  1086. return 0;
  1087. out_detach:
  1088. for (k = 0; k < i; k++)
  1089. if (ubi_devices[k]) {
  1090. mutex_lock(&ubi_devices_mutex);
  1091. ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
  1092. mutex_unlock(&ubi_devices_mutex);
  1093. }
  1094. kmem_cache_destroy(ubi_wl_entry_slab);
  1095. out_dev_unreg:
  1096. misc_deregister(&ubi_ctrl_cdev);
  1097. out_version:
  1098. class_remove_file(ubi_class, &ubi_version);
  1099. out_class:
  1100. class_destroy(ubi_class);
  1101. out:
  1102. ubi_err("UBI error: cannot initialize UBI, error %d", err);
  1103. return err;
  1104. }
  1105. module_init(ubi_init);
  1106. static void __exit ubi_exit(void)
  1107. {
  1108. int i;
  1109. for (i = 0; i < UBI_MAX_DEVICES; i++)
  1110. if (ubi_devices[i]) {
  1111. mutex_lock(&ubi_devices_mutex);
  1112. ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
  1113. mutex_unlock(&ubi_devices_mutex);
  1114. }
  1115. kmem_cache_destroy(ubi_wl_entry_slab);
  1116. misc_deregister(&ubi_ctrl_cdev);
  1117. class_remove_file(ubi_class, &ubi_version);
  1118. class_destroy(ubi_class);
  1119. }
  1120. module_exit(ubi_exit);
  1121. /**
  1122. * bytes_str_to_int - convert a number of bytes string into an integer.
  1123. * @str: the string to convert
  1124. *
  1125. * This function returns positive resulting integer in case of success and a
  1126. * negative error code in case of failure.
  1127. */
  1128. static int __init bytes_str_to_int(const char *str)
  1129. {
  1130. char *endp;
  1131. unsigned long result;
  1132. result = simple_strtoul(str, &endp, 0);
  1133. if (str == endp || result >= INT_MAX) {
  1134. printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
  1135. str);
  1136. return -EINVAL;
  1137. }
  1138. switch (*endp) {
  1139. case 'G':
  1140. result *= 1024;
  1141. case 'M':
  1142. result *= 1024;
  1143. case 'K':
  1144. result *= 1024;
  1145. if (endp[1] == 'i' && endp[2] == 'B')
  1146. endp += 2;
  1147. case '\0':
  1148. break;
  1149. default:
  1150. printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
  1151. str);
  1152. return -EINVAL;
  1153. }
  1154. return result;
  1155. }
  1156. /**
  1157. * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
  1158. * @val: the parameter value to parse
  1159. * @kp: not used
  1160. *
  1161. * This function returns zero in case of success and a negative error code in
  1162. * case of error.
  1163. */
  1164. static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
  1165. {
  1166. int i, len;
  1167. struct mtd_dev_param *p;
  1168. char buf[MTD_PARAM_LEN_MAX];
  1169. char *pbuf = &buf[0];
  1170. char *tokens[2] = {NULL, NULL};
  1171. if (!val)
  1172. return -EINVAL;
  1173. if (mtd_devs == UBI_MAX_DEVICES) {
  1174. printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
  1175. UBI_MAX_DEVICES);
  1176. return -EINVAL;
  1177. }
  1178. len = strnlen(val, MTD_PARAM_LEN_MAX);
  1179. if (len == MTD_PARAM_LEN_MAX) {
  1180. printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
  1181. "max. is %d\n", val, MTD_PARAM_LEN_MAX);
  1182. return -EINVAL;
  1183. }
  1184. if (len == 0) {
  1185. printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
  1186. "ignored\n");
  1187. return 0;
  1188. }
  1189. strcpy(buf, val);
  1190. /* Get rid of the final newline */
  1191. if (buf[len - 1] == '\n')
  1192. buf[len - 1] = '\0';
  1193. for (i = 0; i < 2; i++)
  1194. tokens[i] = strsep(&pbuf, ",");
  1195. if (pbuf) {
  1196. printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
  1197. val);
  1198. return -EINVAL;
  1199. }
  1200. p = &mtd_dev_param[mtd_devs];
  1201. strcpy(&p->name[0], tokens[0]);
  1202. if (tokens[1])
  1203. p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
  1204. if (p->vid_hdr_offs < 0)
  1205. return p->vid_hdr_offs;
  1206. mtd_devs += 1;
  1207. return 0;
  1208. }
  1209. module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
  1210. MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
  1211. "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
  1212. "Multiple \"mtd\" parameters may be specified.\n"
  1213. "MTD devices may be specified by their number, name, or "
  1214. "path to the MTD character device node.\n"
  1215. "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
  1216. "header position to be used by UBI.\n"
  1217. "Example 1: mtd=/dev/mtd0 - attach MTD device "
  1218. "/dev/mtd0.\n"
  1219. "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
  1220. "with name \"content\" using VID header offset 1984, and "
  1221. "MTD device number 4 with default VID header offset.");
  1222. MODULE_VERSION(__stringify(UBI_VERSION));
  1223. MODULE_DESCRIPTION("UBI - Unsorted Block Images");
  1224. MODULE_AUTHOR("Artem Bityutskiy");
  1225. MODULE_LICENSE("GPL");