cmd_ubi.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  1. /*
  2. * Unsorted Block Image commands
  3. *
  4. * Copyright (C) 2008 Samsung Electronics
  5. * Kyungmin Park <kyungmin.park@samsung.com>
  6. *
  7. * Copyright 2008-2009 Stefan Roese <sr@denx.de>, DENX Software Engineering
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License version 2 as
  11. * published by the Free Software Foundation.
  12. */
  13. #include <common.h>
  14. #include <command.h>
  15. #include <exports.h>
  16. #include <nand.h>
  17. #include <onenand_uboot.h>
  18. #include <linux/mtd/mtd.h>
  19. #include <linux/mtd/partitions.h>
  20. #include <linux/err.h>
  21. #include <ubi_uboot.h>
  22. #include <asm/errno.h>
  23. #include <jffs2/load_kernel.h>
  24. #undef ubi_msg
  25. #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
  26. #define DEV_TYPE_NONE 0
  27. #define DEV_TYPE_NAND 1
  28. #define DEV_TYPE_ONENAND 2
  29. #define DEV_TYPE_NOR 3
  30. /* Private own data */
  31. static struct ubi_device *ubi;
  32. static char buffer[80];
  33. static int ubi_initialized;
  34. struct selected_dev {
  35. char part_name[80];
  36. int selected;
  37. int nr;
  38. struct mtd_info *mtd_info;
  39. };
  40. static struct selected_dev ubi_dev;
  41. #ifdef CONFIG_CMD_UBIFS
  42. int ubifs_is_mounted(void);
  43. void cmd_ubifs_umount(void);
  44. #endif
  45. static void display_volume_info(struct ubi_device *ubi)
  46. {
  47. int i;
  48. for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
  49. if (!ubi->volumes[i])
  50. continue; /* Empty record */
  51. ubi_dump_vol_info(ubi->volumes[i]);
  52. }
  53. }
  54. static void display_ubi_info(struct ubi_device *ubi)
  55. {
  56. ubi_msg("MTD device name: \"%s\"", ubi->mtd->name);
  57. ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
  58. ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
  59. ubi->peb_size, ubi->peb_size >> 10);
  60. ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
  61. ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
  62. ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
  63. ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
  64. ubi_msg("VID header offset: %d (aligned %d)",
  65. ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
  66. ubi_msg("data offset: %d", ubi->leb_start);
  67. ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
  68. ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
  69. ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
  70. ubi_msg("number of user volumes: %d",
  71. ubi->vol_count - UBI_INT_VOL_COUNT);
  72. ubi_msg("available PEBs: %d", ubi->avail_pebs);
  73. ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
  74. ubi_msg("number of PEBs reserved for bad PEB handling: %d",
  75. ubi->beb_rsvd_pebs);
  76. ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
  77. }
  78. static int ubi_info(int layout)
  79. {
  80. if (layout)
  81. display_volume_info(ubi);
  82. else
  83. display_ubi_info(ubi);
  84. return 0;
  85. }
  86. static int ubi_check_volumename(const struct ubi_volume *vol, char *name)
  87. {
  88. return strcmp(vol->name, name);
  89. }
  90. static int ubi_check(char *name)
  91. {
  92. int i;
  93. for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
  94. if (!ubi->volumes[i])
  95. continue; /* Empty record */
  96. if (!ubi_check_volumename(ubi->volumes[i], name))
  97. return 0;
  98. }
  99. return -EEXIST;
  100. }
  101. static int verify_mkvol_req(const struct ubi_device *ubi,
  102. const struct ubi_mkvol_req *req)
  103. {
  104. int n, err = EINVAL;
  105. if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
  106. req->name_len < 0)
  107. goto bad;
  108. if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
  109. req->vol_id != UBI_VOL_NUM_AUTO)
  110. goto bad;
  111. if (req->alignment == 0)
  112. goto bad;
  113. if (req->bytes == 0) {
  114. printf("No space left in UBI device!\n");
  115. err = ENOMEM;
  116. goto bad;
  117. }
  118. if (req->vol_type != UBI_DYNAMIC_VOLUME &&
  119. req->vol_type != UBI_STATIC_VOLUME)
  120. goto bad;
  121. if (req->alignment > ubi->leb_size)
  122. goto bad;
  123. n = req->alignment % ubi->min_io_size;
  124. if (req->alignment != 1 && n)
  125. goto bad;
  126. if (req->name_len > UBI_VOL_NAME_MAX) {
  127. printf("Name too long!\n");
  128. err = ENAMETOOLONG;
  129. goto bad;
  130. }
  131. return 0;
  132. bad:
  133. return err;
  134. }
  135. static int ubi_create_vol(char *volume, int64_t size, int dynamic)
  136. {
  137. struct ubi_mkvol_req req;
  138. int err;
  139. if (dynamic)
  140. req.vol_type = UBI_DYNAMIC_VOLUME;
  141. else
  142. req.vol_type = UBI_STATIC_VOLUME;
  143. req.vol_id = UBI_VOL_NUM_AUTO;
  144. req.alignment = 1;
  145. req.bytes = size;
  146. strcpy(req.name, volume);
  147. req.name_len = strlen(volume);
  148. req.name[req.name_len] = '\0';
  149. req.padding1 = 0;
  150. /* It's duplicated at drivers/mtd/ubi/cdev.c */
  151. err = verify_mkvol_req(ubi, &req);
  152. if (err) {
  153. printf("verify_mkvol_req failed %d\n", err);
  154. return err;
  155. }
  156. printf("Creating %s volume %s of size %lld\n",
  157. dynamic ? "dynamic" : "static", volume, size);
  158. /* Call real ubi create volume */
  159. return ubi_create_volume(ubi, &req);
  160. }
  161. static struct ubi_volume *ubi_find_volume(char *volume)
  162. {
  163. struct ubi_volume *vol = NULL;
  164. int i;
  165. for (i = 0; i < ubi->vtbl_slots; i++) {
  166. vol = ubi->volumes[i];
  167. if (vol && !strcmp(vol->name, volume))
  168. return vol;
  169. }
  170. printf("Volume %s not found!\n", volume);
  171. return NULL;
  172. }
  173. static int ubi_remove_vol(char *volume)
  174. {
  175. int err, reserved_pebs, i;
  176. struct ubi_volume *vol;
  177. vol = ubi_find_volume(volume);
  178. if (vol == NULL)
  179. return ENODEV;
  180. printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
  181. if (ubi->ro_mode) {
  182. printf("It's read-only mode\n");
  183. err = EROFS;
  184. goto out_err;
  185. }
  186. err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
  187. if (err) {
  188. printf("Error changing Vol tabel record err=%x\n", err);
  189. goto out_err;
  190. }
  191. reserved_pebs = vol->reserved_pebs;
  192. for (i = 0; i < vol->reserved_pebs; i++) {
  193. err = ubi_eba_unmap_leb(ubi, vol, i);
  194. if (err)
  195. goto out_err;
  196. }
  197. kfree(vol->eba_tbl);
  198. ubi->volumes[vol->vol_id]->eba_tbl = NULL;
  199. ubi->volumes[vol->vol_id] = NULL;
  200. ubi->rsvd_pebs -= reserved_pebs;
  201. ubi->avail_pebs += reserved_pebs;
  202. i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
  203. if (i > 0) {
  204. i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
  205. ubi->avail_pebs -= i;
  206. ubi->rsvd_pebs += i;
  207. ubi->beb_rsvd_pebs += i;
  208. if (i > 0)
  209. ubi_msg("reserve more %d PEBs", i);
  210. }
  211. ubi->vol_count -= 1;
  212. return 0;
  213. out_err:
  214. ubi_err("cannot remove volume %s, error %d", volume, err);
  215. if (err < 0)
  216. err = -err;
  217. return err;
  218. }
  219. static int ubi_volume_continue_write(char *volume, void *buf, size_t size)
  220. {
  221. int err = 1;
  222. struct ubi_volume *vol;
  223. vol = ubi_find_volume(volume);
  224. if (vol == NULL)
  225. return ENODEV;
  226. err = ubi_more_update_data(ubi, vol, buf, size);
  227. if (err < 0) {
  228. printf("Couldnt or partially wrote data\n");
  229. return -err;
  230. }
  231. if (err) {
  232. size = err;
  233. err = ubi_check_volume(ubi, vol->vol_id);
  234. if (err < 0)
  235. return -err;
  236. if (err) {
  237. ubi_warn("volume %d on UBI device %d is corrupted",
  238. vol->vol_id, ubi->ubi_num);
  239. vol->corrupted = 1;
  240. }
  241. vol->checked = 1;
  242. ubi_gluebi_updated(vol);
  243. }
  244. return 0;
  245. }
  246. int ubi_volume_begin_write(char *volume, void *buf, size_t size,
  247. size_t full_size)
  248. {
  249. int err = 1;
  250. int rsvd_bytes = 0;
  251. struct ubi_volume *vol;
  252. vol = ubi_find_volume(volume);
  253. if (vol == NULL)
  254. return ENODEV;
  255. rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
  256. if (size < 0 || size > rsvd_bytes) {
  257. printf("size > volume size! Aborting!\n");
  258. return EINVAL;
  259. }
  260. err = ubi_start_update(ubi, vol, full_size);
  261. if (err < 0) {
  262. printf("Cannot start volume update\n");
  263. return -err;
  264. }
  265. return ubi_volume_continue_write(volume, buf, size);
  266. }
  267. int ubi_volume_write(char *volume, void *buf, size_t size)
  268. {
  269. return ubi_volume_begin_write(volume, buf, size, size);
  270. }
  271. int ubi_volume_read(char *volume, char *buf, size_t size)
  272. {
  273. int err, lnum, off, len, tbuf_size;
  274. void *tbuf;
  275. unsigned long long tmp;
  276. struct ubi_volume *vol;
  277. loff_t offp = 0;
  278. vol = ubi_find_volume(volume);
  279. if (vol == NULL)
  280. return ENODEV;
  281. if (vol->updating) {
  282. printf("updating");
  283. return EBUSY;
  284. }
  285. if (vol->upd_marker) {
  286. printf("damaged volume, update marker is set");
  287. return EBADF;
  288. }
  289. if (offp == vol->used_bytes)
  290. return 0;
  291. if (size == 0) {
  292. printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
  293. size = vol->used_bytes;
  294. }
  295. if (vol->corrupted)
  296. printf("read from corrupted volume %d", vol->vol_id);
  297. if (offp + size > vol->used_bytes)
  298. size = vol->used_bytes - offp;
  299. tbuf_size = vol->usable_leb_size;
  300. if (size < tbuf_size)
  301. tbuf_size = ALIGN(size, ubi->min_io_size);
  302. tbuf = malloc(tbuf_size);
  303. if (!tbuf) {
  304. printf("NO MEM\n");
  305. return ENOMEM;
  306. }
  307. len = size > tbuf_size ? tbuf_size : size;
  308. tmp = offp;
  309. off = do_div(tmp, vol->usable_leb_size);
  310. lnum = tmp;
  311. do {
  312. if (off + len >= vol->usable_leb_size)
  313. len = vol->usable_leb_size - off;
  314. err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
  315. if (err) {
  316. printf("read err %x\n", err);
  317. err = -err;
  318. break;
  319. }
  320. off += len;
  321. if (off == vol->usable_leb_size) {
  322. lnum += 1;
  323. off -= vol->usable_leb_size;
  324. }
  325. size -= len;
  326. offp += len;
  327. memcpy(buf, tbuf, len);
  328. buf += len;
  329. len = size > tbuf_size ? tbuf_size : size;
  330. } while (size);
  331. free(tbuf);
  332. return err;
  333. }
  334. static int ubi_dev_scan(struct mtd_info *info, char *ubidev,
  335. const char *vid_header_offset)
  336. {
  337. struct mtd_device *dev;
  338. struct part_info *part;
  339. struct mtd_partition mtd_part;
  340. char ubi_mtd_param_buffer[80];
  341. u8 pnum;
  342. int err;
  343. if (find_dev_and_part(ubidev, &dev, &pnum, &part) != 0)
  344. return 1;
  345. sprintf(buffer, "mtd=%d", pnum);
  346. memset(&mtd_part, 0, sizeof(mtd_part));
  347. mtd_part.name = buffer;
  348. mtd_part.size = part->size;
  349. mtd_part.offset = part->offset;
  350. add_mtd_partitions(info, &mtd_part, 1);
  351. strcpy(ubi_mtd_param_buffer, buffer);
  352. if (vid_header_offset)
  353. sprintf(ubi_mtd_param_buffer, "mtd=%d,%s", pnum,
  354. vid_header_offset);
  355. err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
  356. if (err) {
  357. del_mtd_partitions(info);
  358. return -err;
  359. }
  360. err = ubi_init();
  361. if (err) {
  362. del_mtd_partitions(info);
  363. return -err;
  364. }
  365. ubi_initialized = 1;
  366. return 0;
  367. }
  368. int ubi_part(char *part_name, const char *vid_header_offset)
  369. {
  370. int err = 0;
  371. char mtd_dev[16];
  372. struct mtd_device *dev;
  373. struct part_info *part;
  374. u8 pnum;
  375. if (mtdparts_init() != 0) {
  376. printf("Error initializing mtdparts!\n");
  377. return 1;
  378. }
  379. #ifdef CONFIG_CMD_UBIFS
  380. /*
  381. * Automatically unmount UBIFS partition when user
  382. * changes the UBI device. Otherwise the following
  383. * UBIFS commands will crash.
  384. */
  385. if (ubifs_is_mounted())
  386. cmd_ubifs_umount();
  387. #endif
  388. /* todo: get dev number for NAND... */
  389. ubi_dev.nr = 0;
  390. /*
  391. * Call ubi_exit() before re-initializing the UBI subsystem
  392. */
  393. if (ubi_initialized) {
  394. ubi_exit();
  395. del_mtd_partitions(ubi_dev.mtd_info);
  396. }
  397. /*
  398. * Search the mtd device number where this partition
  399. * is located
  400. */
  401. if (find_dev_and_part(part_name, &dev, &pnum, &part)) {
  402. printf("Partition %s not found!\n", part_name);
  403. return 1;
  404. }
  405. sprintf(mtd_dev, "%s%d", MTD_DEV_TYPE(dev->id->type), dev->id->num);
  406. ubi_dev.mtd_info = get_mtd_device_nm(mtd_dev);
  407. if (IS_ERR(ubi_dev.mtd_info)) {
  408. printf("Partition %s not found on device %s!\n", part_name,
  409. mtd_dev);
  410. return 1;
  411. }
  412. ubi_dev.selected = 1;
  413. strcpy(ubi_dev.part_name, part_name);
  414. err = ubi_dev_scan(ubi_dev.mtd_info, ubi_dev.part_name,
  415. vid_header_offset);
  416. if (err) {
  417. printf("UBI init error %d\n", err);
  418. ubi_dev.selected = 0;
  419. return err;
  420. }
  421. ubi = ubi_devices[0];
  422. return 0;
  423. }
  424. static int do_ubi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  425. {
  426. int64_t size = 0;
  427. ulong addr = 0;
  428. if (argc < 2)
  429. return CMD_RET_USAGE;
  430. if (strcmp(argv[1], "part") == 0) {
  431. const char *vid_header_offset = NULL;
  432. /* Print current partition */
  433. if (argc == 2) {
  434. if (!ubi_dev.selected) {
  435. printf("Error, no UBI device/partition selected!\n");
  436. return 1;
  437. }
  438. printf("Device %d: %s, partition %s\n",
  439. ubi_dev.nr, ubi_dev.mtd_info->name, ubi_dev.part_name);
  440. return 0;
  441. }
  442. if (argc < 3)
  443. return CMD_RET_USAGE;
  444. if (argc > 3)
  445. vid_header_offset = argv[3];
  446. return ubi_part(argv[2], vid_header_offset);
  447. }
  448. if ((strcmp(argv[1], "part") != 0) && (!ubi_dev.selected)) {
  449. printf("Error, no UBI device/partition selected!\n");
  450. return 1;
  451. }
  452. if (strcmp(argv[1], "info") == 0) {
  453. int layout = 0;
  454. if (argc > 2 && !strncmp(argv[2], "l", 1))
  455. layout = 1;
  456. return ubi_info(layout);
  457. }
  458. if (strcmp(argv[1], "check") == 0) {
  459. if (argc > 2)
  460. return ubi_check(argv[2]);
  461. printf("Error, no volume name passed\n");
  462. return 1;
  463. }
  464. if (strncmp(argv[1], "create", 6) == 0) {
  465. int dynamic = 1; /* default: dynamic volume */
  466. /* Use maximum available size */
  467. size = 0;
  468. /* E.g., create volume size type */
  469. if (argc == 5) {
  470. if (strncmp(argv[4], "s", 1) == 0)
  471. dynamic = 0;
  472. else if (strncmp(argv[4], "d", 1) != 0) {
  473. printf("Incorrect type\n");
  474. return 1;
  475. }
  476. argc--;
  477. }
  478. /* E.g., create volume size */
  479. if (argc == 4) {
  480. size = simple_strtoull(argv[3], NULL, 16);
  481. argc--;
  482. }
  483. /* Use maximum available size */
  484. if (!size) {
  485. size = (int64_t)ubi->avail_pebs * ubi->leb_size;
  486. printf("No size specified -> Using max size (%lld)\n", size);
  487. }
  488. /* E.g., create volume */
  489. if (argc == 3)
  490. return ubi_create_vol(argv[2], size, dynamic);
  491. }
  492. if (strncmp(argv[1], "remove", 6) == 0) {
  493. /* E.g., remove volume */
  494. if (argc == 3)
  495. return ubi_remove_vol(argv[2]);
  496. }
  497. if (strncmp(argv[1], "write", 5) == 0) {
  498. int ret;
  499. if (argc < 5) {
  500. printf("Please see usage\n");
  501. return 1;
  502. }
  503. addr = simple_strtoul(argv[2], NULL, 16);
  504. size = simple_strtoul(argv[4], NULL, 16);
  505. if (strlen(argv[1]) == 10 &&
  506. strncmp(argv[1] + 5, ".part", 5) == 0) {
  507. if (argc < 6) {
  508. ret = ubi_volume_continue_write(argv[3],
  509. (void *)addr, size);
  510. } else {
  511. size_t full_size;
  512. full_size = simple_strtoul(argv[5], NULL, 16);
  513. ret = ubi_volume_begin_write(argv[3],
  514. (void *)addr, size, full_size);
  515. }
  516. } else {
  517. ret = ubi_volume_write(argv[3], (void *)addr, size);
  518. }
  519. if (!ret) {
  520. printf("%lld bytes written to volume %s\n", size,
  521. argv[3]);
  522. }
  523. return ret;
  524. }
  525. if (strncmp(argv[1], "read", 4) == 0) {
  526. size = 0;
  527. /* E.g., read volume size */
  528. if (argc == 5) {
  529. size = simple_strtoul(argv[4], NULL, 16);
  530. argc--;
  531. }
  532. /* E.g., read volume */
  533. if (argc == 4) {
  534. addr = simple_strtoul(argv[2], NULL, 16);
  535. argc--;
  536. }
  537. if (argc == 3) {
  538. printf("Read %lld bytes from volume %s to %lx\n", size,
  539. argv[3], addr);
  540. return ubi_volume_read(argv[3], (char *)addr, size);
  541. }
  542. }
  543. printf("Please see usage\n");
  544. return 1;
  545. }
  546. U_BOOT_CMD(
  547. ubi, 6, 1, do_ubi,
  548. "ubi commands",
  549. "part [part] [offset]\n"
  550. " - Show or set current partition (with optional VID"
  551. " header offset)\n"
  552. "ubi info [l[ayout]]"
  553. " - Display volume and ubi layout information\n"
  554. "ubi check volumename"
  555. " - check if volumename exists\n"
  556. "ubi create[vol] volume [size] [type]"
  557. " - create volume name with size\n"
  558. "ubi write[vol] address volume size"
  559. " - Write volume from address with size\n"
  560. "ubi write.part address volume size [fullsize]\n"
  561. " - Write part of a volume from address\n"
  562. "ubi read[vol] address volume [size]"
  563. " - Read volume to address with size\n"
  564. "ubi remove[vol] volume"
  565. " - Remove volume\n"
  566. "[Legends]\n"
  567. " volume: character name\n"
  568. " size: specified in bytes\n"
  569. " type: s[tatic] or d[ynamic] (default=dynamic)"
  570. );