rockchip: Remove ARCH= references from documentation
[oweals/u-boot.git] / cmd / ubi.c
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
14 #include <common.h>
15 #include <command.h>
16 #include <env.h>
17 #include <exports.h>
18 #include <malloc.h>
19 #include <memalign.h>
20 #include <mtd.h>
21 #include <nand.h>
22 #include <onenand_uboot.h>
23 #include <dm/devres.h>
24 #include <linux/mtd/mtd.h>
25 #include <linux/mtd/partitions.h>
26 #include <linux/err.h>
27 #include <ubi_uboot.h>
28 #include <linux/errno.h>
29 #include <jffs2/load_kernel.h>
30
31 #undef ubi_msg
32 #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
33
34 /* Private own data */
35 static struct ubi_device *ubi;
36
37 #ifdef CONFIG_CMD_UBIFS
38 #include <ubifs_uboot.h>
39 #endif
40
41 static void display_volume_info(struct ubi_device *ubi)
42 {
43         int i;
44
45         for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
46                 if (!ubi->volumes[i])
47                         continue;       /* Empty record */
48                 ubi_dump_vol_info(ubi->volumes[i]);
49         }
50 }
51
52 static void display_ubi_info(struct ubi_device *ubi)
53 {
54         ubi_msg("MTD device name:            \"%s\"", ubi->mtd->name);
55         ubi_msg("MTD device size:            %llu MiB", ubi->flash_size >> 20);
56         ubi_msg("physical eraseblock size:   %d bytes (%d KiB)",
57                         ubi->peb_size, ubi->peb_size >> 10);
58         ubi_msg("logical eraseblock size:    %d bytes", ubi->leb_size);
59         ubi_msg("number of good PEBs:        %d", ubi->good_peb_count);
60         ubi_msg("number of bad PEBs:         %d", ubi->bad_peb_count);
61         ubi_msg("smallest flash I/O unit:    %d", ubi->min_io_size);
62         ubi_msg("VID header offset:          %d (aligned %d)",
63                         ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
64         ubi_msg("data offset:                %d", ubi->leb_start);
65         ubi_msg("max. allowed volumes:       %d", ubi->vtbl_slots);
66         ubi_msg("wear-leveling threshold:    %d", CONFIG_MTD_UBI_WL_THRESHOLD);
67         ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
68         ubi_msg("number of user volumes:     %d",
69                         ubi->vol_count - UBI_INT_VOL_COUNT);
70         ubi_msg("available PEBs:             %d", ubi->avail_pebs);
71         ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
72         ubi_msg("number of PEBs reserved for bad PEB handling: %d",
73                         ubi->beb_rsvd_pebs);
74         ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
75 }
76
77 static int ubi_info(int layout)
78 {
79         if (layout)
80                 display_volume_info(ubi);
81         else
82                 display_ubi_info(ubi);
83
84         return 0;
85 }
86
87 static int ubi_check_volumename(const struct ubi_volume *vol, char *name)
88 {
89         return strcmp(vol->name, name);
90 }
91
92 static int ubi_check(char *name)
93 {
94         int i;
95
96         for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
97                 if (!ubi->volumes[i])
98                         continue;       /* Empty record */
99
100                 if (!ubi_check_volumename(ubi->volumes[i], name))
101                         return 0;
102         }
103
104         return 1;
105 }
106
107 static int verify_mkvol_req(const struct ubi_device *ubi,
108                             const struct ubi_mkvol_req *req)
109 {
110         int n, err = EINVAL;
111
112         if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
113             req->name_len < 0)
114                 goto bad;
115
116         if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
117             req->vol_id != UBI_VOL_NUM_AUTO)
118                 goto bad;
119
120         if (req->alignment == 0)
121                 goto bad;
122
123         if (req->bytes == 0) {
124                 printf("No space left in UBI device!\n");
125                 err = ENOMEM;
126                 goto bad;
127         }
128
129         if (req->vol_type != UBI_DYNAMIC_VOLUME &&
130             req->vol_type != UBI_STATIC_VOLUME)
131                 goto bad;
132
133         if (req->alignment > ubi->leb_size)
134                 goto bad;
135
136         n = req->alignment % ubi->min_io_size;
137         if (req->alignment != 1 && n)
138                 goto bad;
139
140         if (req->name_len > UBI_VOL_NAME_MAX) {
141                 printf("Name too long!\n");
142                 err = ENAMETOOLONG;
143                 goto bad;
144         }
145
146         return 0;
147 bad:
148         return err;
149 }
150
151 static int ubi_create_vol(char *volume, int64_t size, int dynamic, int vol_id,
152                           bool skipcheck)
153 {
154         struct ubi_mkvol_req req;
155         int err;
156
157         if (dynamic)
158                 req.vol_type = UBI_DYNAMIC_VOLUME;
159         else
160                 req.vol_type = UBI_STATIC_VOLUME;
161
162         req.vol_id = vol_id;
163         req.alignment = 1;
164         req.bytes = size;
165
166         strcpy(req.name, volume);
167         req.name_len = strlen(volume);
168         req.name[req.name_len] = '\0';
169         req.flags = 0;
170         if (skipcheck)
171                 req.flags |= UBI_VOL_SKIP_CRC_CHECK_FLG;
172
173         /* It's duplicated at drivers/mtd/ubi/cdev.c */
174         err = verify_mkvol_req(ubi, &req);
175         if (err) {
176                 printf("verify_mkvol_req failed %d\n", err);
177                 return err;
178         }
179         printf("Creating %s volume %s of size %lld\n",
180                 dynamic ? "dynamic" : "static", volume, size);
181         /* Call real ubi create volume */
182         return ubi_create_volume(ubi, &req);
183 }
184
185 static struct ubi_volume *ubi_find_volume(char *volume)
186 {
187         struct ubi_volume *vol = NULL;
188         int i;
189
190         for (i = 0; i < ubi->vtbl_slots; i++) {
191                 vol = ubi->volumes[i];
192                 if (vol && !strcmp(vol->name, volume))
193                         return vol;
194         }
195
196         printf("Volume %s not found!\n", volume);
197         return NULL;
198 }
199
200 static int ubi_remove_vol(char *volume)
201 {
202         int err, reserved_pebs, i;
203         struct ubi_volume *vol;
204
205         vol = ubi_find_volume(volume);
206         if (vol == NULL)
207                 return ENODEV;
208
209         printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
210
211         if (ubi->ro_mode) {
212                 printf("It's read-only mode\n");
213                 err = EROFS;
214                 goto out_err;
215         }
216
217         err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
218         if (err) {
219                 printf("Error changing Vol tabel record err=%x\n", err);
220                 goto out_err;
221         }
222         reserved_pebs = vol->reserved_pebs;
223         for (i = 0; i < vol->reserved_pebs; i++) {
224                 err = ubi_eba_unmap_leb(ubi, vol, i);
225                 if (err)
226                         goto out_err;
227         }
228
229         kfree(vol->eba_tbl);
230         ubi->volumes[vol->vol_id]->eba_tbl = NULL;
231         ubi->volumes[vol->vol_id] = NULL;
232
233         ubi->rsvd_pebs -= reserved_pebs;
234         ubi->avail_pebs += reserved_pebs;
235         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
236         if (i > 0) {
237                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
238                 ubi->avail_pebs -= i;
239                 ubi->rsvd_pebs += i;
240                 ubi->beb_rsvd_pebs += i;
241                 if (i > 0)
242                         ubi_msg("reserve more %d PEBs", i);
243         }
244         ubi->vol_count -= 1;
245
246         return 0;
247 out_err:
248         ubi_err(ubi, "cannot remove volume %s, error %d", volume, err);
249         if (err < 0)
250                 err = -err;
251         return err;
252 }
253
254 static int ubi_rename_vol(char *oldname, char *newname)
255 {
256         struct ubi_volume *vol;
257         struct ubi_rename_entry rename;
258         struct ubi_volume_desc desc;
259         struct list_head list;
260
261         vol = ubi_find_volume(oldname);
262         if (!vol) {
263                 printf("%s: volume %s doesn't exist\n", __func__, oldname);
264                 return ENODEV;
265         }
266
267         printf("Rename UBI volume %s to %s\n", oldname, newname);
268
269         if (ubi->ro_mode) {
270                 printf("%s: ubi device is in read-only mode\n", __func__);
271                 return EROFS;
272         }
273
274         rename.new_name_len = strlen(newname);
275         strcpy(rename.new_name, newname);
276         rename.remove = 0;
277         desc.vol = vol;
278         desc.mode = 0;
279         rename.desc = &desc;
280         INIT_LIST_HEAD(&rename.list);
281         INIT_LIST_HEAD(&list);
282         list_add(&rename.list, &list);
283
284         return ubi_rename_volumes(ubi, &list);
285 }
286
287 static int ubi_volume_continue_write(char *volume, void *buf, size_t size)
288 {
289         int err = 1;
290         struct ubi_volume *vol;
291
292         vol = ubi_find_volume(volume);
293         if (vol == NULL)
294                 return ENODEV;
295
296         err = ubi_more_update_data(ubi, vol, buf, size);
297         if (err < 0) {
298                 printf("Couldnt or partially wrote data\n");
299                 return -err;
300         }
301
302         if (err) {
303                 size = err;
304
305                 err = ubi_check_volume(ubi, vol->vol_id);
306                 if (err < 0)
307                         return -err;
308
309                 if (err) {
310                         ubi_warn(ubi, "volume %d on UBI device %d is corrupt",
311                                  vol->vol_id, ubi->ubi_num);
312                         vol->corrupted = 1;
313                 }
314
315                 vol->checked = 1;
316                 ubi_gluebi_updated(vol);
317         }
318
319         return 0;
320 }
321
322 int ubi_volume_begin_write(char *volume, void *buf, size_t size,
323         size_t full_size)
324 {
325         int err = 1;
326         int rsvd_bytes = 0;
327         struct ubi_volume *vol;
328
329         vol = ubi_find_volume(volume);
330         if (vol == NULL)
331                 return ENODEV;
332
333         rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
334         if (size > rsvd_bytes) {
335                 printf("size > volume size! Aborting!\n");
336                 return EINVAL;
337         }
338
339         err = ubi_start_update(ubi, vol, full_size);
340         if (err < 0) {
341                 printf("Cannot start volume update\n");
342                 return -err;
343         }
344
345         return ubi_volume_continue_write(volume, buf, size);
346 }
347
348 int ubi_volume_write(char *volume, void *buf, size_t size)
349 {
350         return ubi_volume_begin_write(volume, buf, size, size);
351 }
352
353 int ubi_volume_read(char *volume, char *buf, size_t size)
354 {
355         int err, lnum, off, len, tbuf_size;
356         void *tbuf;
357         unsigned long long tmp;
358         struct ubi_volume *vol;
359         loff_t offp = 0;
360         size_t len_read;
361
362         vol = ubi_find_volume(volume);
363         if (vol == NULL)
364                 return ENODEV;
365
366         if (vol->updating) {
367                 printf("updating");
368                 return EBUSY;
369         }
370         if (vol->upd_marker) {
371                 printf("damaged volume, update marker is set");
372                 return EBADF;
373         }
374         if (offp == vol->used_bytes)
375                 return 0;
376
377         if (size == 0) {
378                 printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
379                 size = vol->used_bytes;
380         }
381
382         printf("Read %zu bytes from volume %s to %p\n", size, volume, buf);
383
384         if (vol->corrupted)
385                 printf("read from corrupted volume %d", vol->vol_id);
386         if (offp + size > vol->used_bytes)
387                 size = vol->used_bytes - offp;
388
389         tbuf_size = vol->usable_leb_size;
390         if (size < tbuf_size)
391                 tbuf_size = ALIGN(size, ubi->min_io_size);
392         tbuf = malloc_cache_aligned(tbuf_size);
393         if (!tbuf) {
394                 printf("NO MEM\n");
395                 return ENOMEM;
396         }
397         len = size > tbuf_size ? tbuf_size : size;
398
399         tmp = offp;
400         off = do_div(tmp, vol->usable_leb_size);
401         lnum = tmp;
402         len_read = size;
403         do {
404                 if (off + len >= vol->usable_leb_size)
405                         len = vol->usable_leb_size - off;
406
407                 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
408                 if (err) {
409                         printf("read err %x\n", err);
410                         err = -err;
411                         break;
412                 }
413                 off += len;
414                 if (off == vol->usable_leb_size) {
415                         lnum += 1;
416                         off -= vol->usable_leb_size;
417                 }
418
419                 size -= len;
420                 offp += len;
421
422                 memcpy(buf, tbuf, len);
423
424                 buf += len;
425                 len = size > tbuf_size ? tbuf_size : size;
426         } while (size);
427
428         if (!size)
429                 env_set_hex("filesize", len_read);
430
431         free(tbuf);
432         return err;
433 }
434
435 static int ubi_dev_scan(struct mtd_info *info, const char *vid_header_offset)
436 {
437         char ubi_mtd_param_buffer[80];
438         int err;
439
440         if (!vid_header_offset)
441                 sprintf(ubi_mtd_param_buffer, "%s", info->name);
442         else
443                 sprintf(ubi_mtd_param_buffer, "%s,%s", info->name,
444                         vid_header_offset);
445
446         err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
447         if (err)
448                 return -err;
449
450         err = ubi_init();
451         if (err)
452                 return -err;
453
454         return 0;
455 }
456
457 static int ubi_set_skip_check(char *volume, bool skip_check)
458 {
459         struct ubi_vtbl_record vtbl_rec;
460         struct ubi_volume *vol;
461
462         vol = ubi_find_volume(volume);
463         if (!vol)
464                 return ENODEV;
465
466         printf("%sing skip_check on volume %s\n",
467                skip_check ? "Sett" : "Clear", volume);
468
469         vtbl_rec = ubi->vtbl[vol->vol_id];
470         if (skip_check) {
471                 vtbl_rec.flags |= UBI_VTBL_SKIP_CRC_CHECK_FLG;
472                 vol->skip_check = 1;
473         } else {
474                 vtbl_rec.flags &= ~UBI_VTBL_SKIP_CRC_CHECK_FLG;
475                 vol->skip_check = 0;
476         }
477
478         return ubi_change_vtbl_record(ubi, vol->vol_id, &vtbl_rec);
479 }
480
481 static int ubi_detach(void)
482 {
483 #ifdef CONFIG_CMD_UBIFS
484         /*
485          * Automatically unmount UBIFS partition when user
486          * changes the UBI device. Otherwise the following
487          * UBIFS commands will crash.
488          */
489         if (ubifs_is_mounted())
490                 cmd_ubifs_umount();
491 #endif
492
493         /*
494          * Call ubi_exit() before re-initializing the UBI subsystem
495          */
496         if (ubi)
497                 ubi_exit();
498
499         ubi = NULL;
500
501         return 0;
502 }
503
504 int ubi_part(char *part_name, const char *vid_header_offset)
505 {
506         struct mtd_info *mtd;
507         int err = 0;
508
509         ubi_detach();
510
511         mtd_probe_devices();
512         mtd = get_mtd_device_nm(part_name);
513         if (IS_ERR(mtd)) {
514                 printf("Partition %s not found!\n", part_name);
515                 return 1;
516         }
517         put_mtd_device(mtd);
518
519         err = ubi_dev_scan(mtd, vid_header_offset);
520         if (err) {
521                 printf("UBI init error %d\n", err);
522                 printf("Please check, if the correct MTD partition is used (size big enough?)\n");
523                 return err;
524         }
525
526         ubi = ubi_devices[0];
527
528         return 0;
529 }
530
531 static int do_ubi(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
532 {
533         int64_t size = 0;
534         ulong addr = 0;
535         bool skipcheck = false;
536
537         if (argc < 2)
538                 return CMD_RET_USAGE;
539
540         if (strcmp(argv[1], "detach") == 0)
541                 return ubi_detach();
542
543         if (strcmp(argv[1], "part") == 0) {
544                 const char *vid_header_offset = NULL;
545
546                 /* Print current partition */
547                 if (argc == 2) {
548                         if (!ubi) {
549                                 printf("Error, no UBI device selected!\n");
550                                 return 1;
551                         }
552
553                         printf("Device %d: %s, MTD partition %s\n",
554                                ubi->ubi_num, ubi->ubi_name, ubi->mtd->name);
555                         return 0;
556                 }
557
558                 if (argc < 3)
559                         return CMD_RET_USAGE;
560
561                 if (argc > 3)
562                         vid_header_offset = argv[3];
563
564                 return ubi_part(argv[2], vid_header_offset);
565         }
566
567         if ((strcmp(argv[1], "part") != 0) && !ubi) {
568                 printf("Error, no UBI device selected!\n");
569                 return 1;
570         }
571
572         if (strcmp(argv[1], "info") == 0) {
573                 int layout = 0;
574                 if (argc > 2 && !strncmp(argv[2], "l", 1))
575                         layout = 1;
576                 return ubi_info(layout);
577         }
578
579         if (strcmp(argv[1], "check") == 0) {
580                 if (argc > 2)
581                         return ubi_check(argv[2]);
582
583                 printf("Error, no volume name passed\n");
584                 return 1;
585         }
586
587         if (strncmp(argv[1], "create", 6) == 0) {
588                 int dynamic = 1;        /* default: dynamic volume */
589                 int id = UBI_VOL_NUM_AUTO;
590
591                 /* Use maximum available size */
592                 size = 0;
593
594                 /* E.g., create volume with "skipcheck" bit set */
595                 if (argc == 7) {
596                         skipcheck = strncmp(argv[6], "--skipcheck", 11) == 0;
597                         argc--;
598                 }
599
600                 /* E.g., create volume size type vol_id */
601                 if (argc == 6) {
602                         id = simple_strtoull(argv[5], NULL, 16);
603                         argc--;
604                 }
605
606                 /* E.g., create volume size type */
607                 if (argc == 5) {
608                         if (strncmp(argv[4], "s", 1) == 0)
609                                 dynamic = 0;
610                         else if (strncmp(argv[4], "d", 1) != 0) {
611                                 printf("Incorrect type\n");
612                                 return 1;
613                         }
614                         argc--;
615                 }
616                 /* E.g., create volume size */
617                 if (argc == 4) {
618                         if (argv[3][0] != '-')
619                                 size = simple_strtoull(argv[3], NULL, 16);
620                         argc--;
621                 }
622                 /* Use maximum available size */
623                 if (!size) {
624                         size = (int64_t)ubi->avail_pebs * ubi->leb_size;
625                         printf("No size specified -> Using max size (%lld)\n", size);
626                 }
627                 /* E.g., create volume */
628                 if (argc == 3) {
629                         return ubi_create_vol(argv[2], size, dynamic, id,
630                                               skipcheck);
631                 }
632         }
633
634         if (strncmp(argv[1], "remove", 6) == 0) {
635                 /* E.g., remove volume */
636                 if (argc == 3)
637                         return ubi_remove_vol(argv[2]);
638         }
639
640         if (IS_ENABLED(CONFIG_CMD_UBI_RENAME) && !strncmp(argv[1], "rename", 6))
641                 return ubi_rename_vol(argv[2], argv[3]);
642
643         if (strncmp(argv[1], "skipcheck", 9) == 0) {
644                 /* E.g., change skip_check flag */
645                 if (argc == 4) {
646                         skipcheck = strncmp(argv[3], "on", 2) == 0;
647                         return ubi_set_skip_check(argv[2], skipcheck);
648                 }
649         }
650
651         if (strncmp(argv[1], "write", 5) == 0) {
652                 int ret;
653
654                 if (argc < 5) {
655                         printf("Please see usage\n");
656                         return 1;
657                 }
658
659                 addr = simple_strtoul(argv[2], NULL, 16);
660                 size = simple_strtoul(argv[4], NULL, 16);
661
662                 if (strlen(argv[1]) == 10 &&
663                     strncmp(argv[1] + 5, ".part", 5) == 0) {
664                         if (argc < 6) {
665                                 ret = ubi_volume_continue_write(argv[3],
666                                                 (void *)addr, size);
667                         } else {
668                                 size_t full_size;
669                                 full_size = simple_strtoul(argv[5], NULL, 16);
670                                 ret = ubi_volume_begin_write(argv[3],
671                                                 (void *)addr, size, full_size);
672                         }
673                 } else {
674                         ret = ubi_volume_write(argv[3], (void *)addr, size);
675                 }
676                 if (!ret) {
677                         printf("%lld bytes written to volume %s\n", size,
678                                argv[3]);
679                 }
680
681                 return ret;
682         }
683
684         if (strncmp(argv[1], "read", 4) == 0) {
685                 size = 0;
686
687                 /* E.g., read volume size */
688                 if (argc == 5) {
689                         size = simple_strtoul(argv[4], NULL, 16);
690                         argc--;
691                 }
692
693                 /* E.g., read volume */
694                 if (argc == 4) {
695                         addr = simple_strtoul(argv[2], NULL, 16);
696                         argc--;
697                 }
698
699                 if (argc == 3) {
700                         return ubi_volume_read(argv[3], (char *)addr, size);
701                 }
702         }
703
704         printf("Please see usage\n");
705         return 1;
706 }
707
708 U_BOOT_CMD(
709         ubi, 7, 1, do_ubi,
710         "ubi commands",
711         "detach"
712                 " - detach ubi from a mtd partition\n"
713         "ubi part [part] [offset]\n"
714                 " - Show or set current partition (with optional VID"
715                 " header offset)\n"
716         "ubi info [l[ayout]]"
717                 " - Display volume and ubi layout information\n"
718         "ubi check volumename"
719                 " - check if volumename exists\n"
720         "ubi create[vol] volume [size] [type] [id] [--skipcheck]\n"
721                 " - create volume name with size ('-' for maximum"
722                 " available size)\n"
723         "ubi write[vol] address volume size"
724                 " - Write volume from address with size\n"
725         "ubi write.part address volume size [fullsize]\n"
726                 " - Write part of a volume from address\n"
727         "ubi read[vol] address volume [size]"
728                 " - Read volume to address with size\n"
729         "ubi remove[vol] volume"
730                 " - Remove volume\n"
731 #if IS_ENABLED(CONFIG_CMD_UBI_RENAME)
732         "ubi rename oldname newname\n"
733 #endif
734         "ubi skipcheck volume on/off - Set or clear skip_check flag in volume header\n"
735         "[Legends]\n"
736         " volume: character name\n"
737         " size: specified in bytes\n"
738         " type: s[tatic] or d[ynamic] (default=dynamic)"
739 );