cmd_ubi.c 14 KB

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