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