blob: 0e62e449327523facec6081d93e724f5beca62e0 [file] [log] [blame]
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +01001/*
2 * Unsorted Block Image commands
3 *
4 * Copyright (C) 2008 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
6 *
Stefan Roese62eafb72009-04-24 20:24:19 +02007 * Copyright 2008-2009 Stefan Roese <sr@denx.de>, DENX Software Engineering
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +01008 *
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
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010014#include <command.h>
Simon Glass313112a2019-08-01 09:46:46 -060015#include <env.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010016#include <exports.h>
Simon Glass9bc15642020-02-03 07:36:16 -070017#include <malloc.h>
Simon Glassa87fc0a2015-09-02 17:24:57 -060018#include <memalign.h>
Miquel Raynal12f1ff12018-09-29 12:58:29 +020019#include <mtd.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010020#include <nand.h>
21#include <onenand_uboot.h>
Simon Glassd66c5f72020-02-03 07:36:15 -070022#include <dm/devres.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010023#include <linux/mtd/mtd.h>
24#include <linux/mtd/partitions.h>
Heiko Schocherf5895d12014-06-24 10:10:04 +020025#include <linux/err.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010026#include <ubi_uboot.h>
Masahiro Yamada56a931c2016-09-21 11:28:55 +090027#include <linux/errno.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010028#include <jffs2/load_kernel.h>
Pali Rohár9395eb92022-09-12 11:38:55 +020029#include <linux/log2.h>
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010030
Joe Hershberger47550fc2013-04-08 10:32:49 +000031#undef ubi_msg
32#define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
33
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010034/* Private own data */
35static struct ubi_device *ubi;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010036
Stefan Roese408c6c42010-11-01 17:28:22 +010037#ifdef CONFIG_CMD_UBIFS
Tien Fong Cheedbc9d852018-07-06 16:25:12 +080038#include <ubifs_uboot.h>
Stefan Roese408c6c42010-11-01 17:28:22 +010039#endif
40
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +010041static 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
52static 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
77static 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
Pali Rohár9395eb92022-09-12 11:38:55 +020087static int ubi_list(const char *var, int numeric)
88{
89 size_t namelen, len, size;
90 char *str, *str2;
91 int i;
92
93 if (!var) {
94 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
95 if (!ubi->volumes[i])
96 continue;
97 if (ubi->volumes[i]->vol_id >= UBI_INTERNAL_VOL_START)
98 continue;
99 printf("%d: %s\n",
100 ubi->volumes[i]->vol_id,
101 ubi->volumes[i]->name);
102 }
103 return 0;
104 }
105
106 len = 0;
107 size = 16;
108 str = malloc(size);
109 if (!str)
110 return 1;
111
112 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
113 if (!ubi->volumes[i])
114 continue;
115 if (ubi->volumes[i]->vol_id >= UBI_INTERNAL_VOL_START)
116 continue;
117
118 if (numeric)
119 namelen = 10; /* strlen(stringify(INT_MAX)) */
120 else
121 namelen = strlen(ubi->volumes[i]->name);
122
123 if (len + namelen + 1 > size) {
124 size = roundup_pow_of_two(len + namelen + 1) * 2;
125 str2 = realloc(str, size);
126 if (!str2) {
127 free(str);
128 return 1;
129 }
130 str = str2;
131 }
132
133 if (len)
134 str[len++] = ' ';
135
136 if (numeric) {
137 len += sprintf(str + len, "%d", ubi->volumes[i]->vol_id) + 1;
138 } else {
139 memcpy(str + len, ubi->volumes[i]->name, namelen);
140 len += namelen;
141 str[len] = 0;
142 }
143 }
144
145 env_set(var, str);
146 free(str);
147
148 return 0;
149}
150
Heiko Schocher1762ab12014-01-25 07:27:11 +0100151static int ubi_check_volumename(const struct ubi_volume *vol, char *name)
152{
153 return strcmp(vol->name, name);
154}
155
156static int ubi_check(char *name)
157{
158 int i;
159
160 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
161 if (!ubi->volumes[i])
162 continue; /* Empty record */
163
164 if (!ubi_check_volumename(ubi->volumes[i], name))
165 return 0;
166 }
167
Stefan Agner6a889f22015-04-10 11:25:43 +0200168 return 1;
Heiko Schocher1762ab12014-01-25 07:27:11 +0100169}
170
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100171static int verify_mkvol_req(const struct ubi_device *ubi,
172 const struct ubi_mkvol_req *req)
173{
Stefan Roese8cfc6962011-03-14 14:34:21 +0100174 int n, err = EINVAL;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100175
176 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
177 req->name_len < 0)
178 goto bad;
179
180 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
181 req->vol_id != UBI_VOL_NUM_AUTO)
182 goto bad;
183
184 if (req->alignment == 0)
185 goto bad;
186
Stefan Roese8cfc6962011-03-14 14:34:21 +0100187 if (req->bytes == 0) {
188 printf("No space left in UBI device!\n");
189 err = ENOMEM;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100190 goto bad;
Stefan Roese8cfc6962011-03-14 14:34:21 +0100191 }
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100192
193 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
194 req->vol_type != UBI_STATIC_VOLUME)
195 goto bad;
196
197 if (req->alignment > ubi->leb_size)
198 goto bad;
199
200 n = req->alignment % ubi->min_io_size;
201 if (req->alignment != 1 && n)
202 goto bad;
203
204 if (req->name_len > UBI_VOL_NAME_MAX) {
Stefan Roese8cfc6962011-03-14 14:34:21 +0100205 printf("Name too long!\n");
206 err = ENAMETOOLONG;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100207 goto bad;
208 }
209
210 return 0;
211bad:
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100212 return err;
213}
214
Quentin Schulza88049b2019-09-12 16:41:01 +0200215static int ubi_create_vol(char *volume, int64_t size, int dynamic, int vol_id,
216 bool skipcheck)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100217{
218 struct ubi_mkvol_req req;
219 int err;
220
221 if (dynamic)
222 req.vol_type = UBI_DYNAMIC_VOLUME;
223 else
224 req.vol_type = UBI_STATIC_VOLUME;
225
Ladislav Michl39370f12016-09-13 07:14:01 +0200226 req.vol_id = vol_id;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100227 req.alignment = 1;
228 req.bytes = size;
229
230 strcpy(req.name, volume);
231 req.name_len = strlen(volume);
232 req.name[req.name_len] = '\0';
Quentin Schulza88049b2019-09-12 16:41:01 +0200233 req.flags = 0;
234 if (skipcheck)
235 req.flags |= UBI_VOL_SKIP_CRC_CHECK_FLG;
236
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100237 /* It's duplicated at drivers/mtd/ubi/cdev.c */
238 err = verify_mkvol_req(ubi, &req);
239 if (err) {
240 printf("verify_mkvol_req failed %d\n", err);
241 return err;
242 }
Paul Burtondf686162013-09-04 15:16:58 +0100243 printf("Creating %s volume %s of size %lld\n",
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100244 dynamic ? "dynamic" : "static", volume, size);
245 /* Call real ubi create volume */
246 return ubi_create_volume(ubi, &req);
247}
248
Stefan Roese8cfc6962011-03-14 14:34:21 +0100249static struct ubi_volume *ubi_find_volume(char *volume)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100250{
Martin Kurbanovfb42f602024-06-16 16:34:17 +0300251 struct ubi_volume *vol;
Stefan Roese8cfc6962011-03-14 14:34:21 +0100252 int i;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100253
254 for (i = 0; i < ubi->vtbl_slots; i++) {
255 vol = ubi->volumes[i];
Stefan Roese8cfc6962011-03-14 14:34:21 +0100256 if (vol && !strcmp(vol->name, volume))
257 return vol;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100258 }
Stefan Roese8cfc6962011-03-14 14:34:21 +0100259
260 printf("Volume %s not found!\n", volume);
261 return NULL;
262}
263
264static int ubi_remove_vol(char *volume)
265{
266 int err, reserved_pebs, i;
267 struct ubi_volume *vol;
268
269 vol = ubi_find_volume(volume);
270 if (vol == NULL)
271 return ENODEV;
272
273 printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100274
275 if (ubi->ro_mode) {
276 printf("It's read-only mode\n");
Stefan Roese8cfc6962011-03-14 14:34:21 +0100277 err = EROFS;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100278 goto out_err;
279 }
280
Stefan Roese8cfc6962011-03-14 14:34:21 +0100281 err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100282 if (err) {
283 printf("Error changing Vol tabel record err=%x\n", err);
284 goto out_err;
285 }
286 reserved_pebs = vol->reserved_pebs;
287 for (i = 0; i < vol->reserved_pebs; i++) {
288 err = ubi_eba_unmap_leb(ubi, vol, i);
289 if (err)
290 goto out_err;
291 }
292
293 kfree(vol->eba_tbl);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100294 ubi->volumes[vol->vol_id]->eba_tbl = NULL;
295 ubi->volumes[vol->vol_id] = NULL;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100296
297 ubi->rsvd_pebs -= reserved_pebs;
298 ubi->avail_pebs += reserved_pebs;
299 i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
300 if (i > 0) {
301 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
302 ubi->avail_pebs -= i;
303 ubi->rsvd_pebs += i;
304 ubi->beb_rsvd_pebs += i;
305 if (i > 0)
306 ubi_msg("reserve more %d PEBs", i);
307 }
308 ubi->vol_count -= 1;
309
310 return 0;
311out_err:
Heiko Schocher94b66de2015-10-22 06:19:21 +0200312 ubi_err(ubi, "cannot remove volume %s, error %d", volume, err);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100313 if (err < 0)
314 err = -err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100315 return err;
316}
317
Philippe Reynes10d53222020-03-23 19:20:47 +0100318static int ubi_rename_vol(char *oldname, char *newname)
319{
320 struct ubi_volume *vol;
321 struct ubi_rename_entry rename;
322 struct ubi_volume_desc desc;
323 struct list_head list;
324
325 vol = ubi_find_volume(oldname);
326 if (!vol) {
327 printf("%s: volume %s doesn't exist\n", __func__, oldname);
328 return ENODEV;
329 }
330
Philippe Reynes0cf9f472020-12-23 15:33:07 +0100331 if (!ubi_check(newname)) {
332 printf("%s: volume %s already exist\n", __func__, newname);
333 return EINVAL;
334 }
335
Philippe Reynes10d53222020-03-23 19:20:47 +0100336 printf("Rename UBI volume %s to %s\n", oldname, newname);
337
338 if (ubi->ro_mode) {
339 printf("%s: ubi device is in read-only mode\n", __func__);
340 return EROFS;
341 }
342
343 rename.new_name_len = strlen(newname);
344 strcpy(rename.new_name, newname);
345 rename.remove = 0;
346 desc.vol = vol;
347 desc.mode = 0;
348 rename.desc = &desc;
349 INIT_LIST_HEAD(&rename.list);
350 INIT_LIST_HEAD(&list);
351 list_add(&rename.list, &list);
352
353 return ubi_rename_volumes(ubi, &list);
354}
355
Jeroen Hofsteef384fbf2014-06-23 00:22:08 +0200356static int ubi_volume_continue_write(char *volume, void *buf, size_t size)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100357{
Martin Kurbanovfb42f602024-06-16 16:34:17 +0300358 int err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100359 struct ubi_volume *vol;
360
Stefan Roese8cfc6962011-03-14 14:34:21 +0100361 vol = ubi_find_volume(volume);
362 if (vol == NULL)
363 return ENODEV;
364
Martin Kurbanovff3f0832024-06-16 16:34:18 +0300365 if (!vol->updating) {
366 printf("UBI volume update was not initiated\n");
367 return EINVAL;
368 }
369
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100370 err = ubi_more_update_data(ubi, vol, buf, size);
371 if (err < 0) {
Stefan Roese8cfc6962011-03-14 14:34:21 +0100372 printf("Couldnt or partially wrote data\n");
373 return -err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100374 }
375
376 if (err) {
377 size = err;
378
379 err = ubi_check_volume(ubi, vol->vol_id);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100380 if (err < 0)
381 return -err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100382
383 if (err) {
Heiko Schocher94b66de2015-10-22 06:19:21 +0200384 ubi_warn(ubi, "volume %d on UBI device %d is corrupt",
385 vol->vol_id, ubi->ubi_num);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100386 vol->corrupted = 1;
387 }
388
389 vol->checked = 1;
390 ubi_gluebi_updated(vol);
391 }
392
393 return 0;
394}
395
Paul Burton6627aa32013-09-04 15:16:59 +0100396int ubi_volume_begin_write(char *volume, void *buf, size_t size,
397 size_t full_size)
398{
Martin Kurbanovfb42f602024-06-16 16:34:17 +0300399 int err;
400 int rsvd_bytes;
Paul Burton6627aa32013-09-04 15:16:59 +0100401 struct ubi_volume *vol;
402
403 vol = ubi_find_volume(volume);
404 if (vol == NULL)
405 return ENODEV;
406
407 rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
xypron.glpk@gmx.de632a9452017-04-15 16:25:25 +0200408 if (size > rsvd_bytes) {
Paul Burton6627aa32013-09-04 15:16:59 +0100409 printf("size > volume size! Aborting!\n");
410 return EINVAL;
411 }
412
413 err = ubi_start_update(ubi, vol, full_size);
414 if (err < 0) {
415 printf("Cannot start volume update\n");
416 return -err;
417 }
418
Martin Kurbanovff3f0832024-06-16 16:34:18 +0300419 /* The volume is just wiped out */
420 if (!full_size)
421 return 0;
422
Paul Burton6627aa32013-09-04 15:16:59 +0100423 return ubi_volume_continue_write(volume, buf, size);
424}
425
Alexey Romanovde417e92024-07-18 08:45:24 +0300426static int ubi_volume_offset_write(char *volume, void *buf, loff_t offset,
427 size_t size)
Paul Burton6627aa32013-09-04 15:16:59 +0100428{
Alexey Romanovde417e92024-07-18 08:45:24 +0300429 int len, tbuf_size, ret;
430 u64 lnum;
431 struct ubi_volume *vol;
432 loff_t off = offset;
433 void *tbuf;
434
435 vol = ubi_find_volume(volume);
436 if (!vol)
437 return -ENODEV;
438
439 if (size > vol->reserved_pebs * (ubi->leb_size - vol->data_pad))
440 return -EINVAL;
441
442 tbuf_size = vol->usable_leb_size;
443 tbuf = malloc_cache_aligned(tbuf_size);
444 if (!tbuf)
445 return -ENOMEM;
446
447 lnum = off;
448 off = do_div(lnum, vol->usable_leb_size);
449
450 do {
451 struct ubi_volume_desc desc = {
452 .vol = vol,
453 .mode = UBI_READWRITE,
454 };
455
456 len = size > tbuf_size ? tbuf_size : size;
457 if (off + len >= vol->usable_leb_size)
458 len = vol->usable_leb_size - off;
459
460 ret = ubi_read(&desc, (int)lnum, tbuf, 0, tbuf_size);
461 if (ret) {
462 pr_err("Failed to read leb %lld (%d)\n", lnum, ret);
463 goto exit;
464 }
465
466 memcpy(tbuf + off, buf, len);
467
468 ret = ubi_leb_change(&desc, (int)lnum, tbuf, tbuf_size);
469 if (ret) {
470 pr_err("Failed to write leb %lld (%d)\n", lnum, ret);
471 goto exit;
472 }
473
474 off += len;
475 if (off >= vol->usable_leb_size) {
476 lnum++;
477 off -= vol->usable_leb_size;
478 }
479
480 buf += len;
481 size -= len;
482 } while (size);
483
484exit:
485 free(tbuf);
486 return ret;
487}
488
489int ubi_volume_write(char *volume, void *buf, loff_t offset, size_t size)
490{
491 if (!offset)
492 return ubi_volume_begin_write(volume, buf, size, size);
493
494 return ubi_volume_offset_write(volume, buf, offset, size);
Paul Burton6627aa32013-09-04 15:16:59 +0100495}
496
Alexey Romanov0043a972024-07-18 08:45:23 +0300497int ubi_volume_read(char *volume, char *buf, loff_t offset, size_t size)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100498{
Stefan Roese8cfc6962011-03-14 14:34:21 +0100499 int err, lnum, off, len, tbuf_size;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100500 void *tbuf;
501 unsigned long long tmp;
Stefan Roese8cfc6962011-03-14 14:34:21 +0100502 struct ubi_volume *vol;
Alexey Romanov0043a972024-07-18 08:45:23 +0300503 loff_t offp = offset;
Holger Denglera14912b2017-08-30 18:38:52 +0200504 size_t len_read;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100505
Stefan Roese8cfc6962011-03-14 14:34:21 +0100506 vol = ubi_find_volume(volume);
507 if (vol == NULL)
508 return ENODEV;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100509
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100510 if (vol->updating) {
511 printf("updating");
Stefan Roese8cfc6962011-03-14 14:34:21 +0100512 return EBUSY;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100513 }
514 if (vol->upd_marker) {
515 printf("damaged volume, update marker is set");
Stefan Roese8cfc6962011-03-14 14:34:21 +0100516 return EBADF;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100517 }
518 if (offp == vol->used_bytes)
519 return 0;
520
521 if (size == 0) {
Stefan Roese8cfc6962011-03-14 14:34:21 +0100522 printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100523 size = vol->used_bytes;
524 }
525
Tom Rini3aa6e392018-07-26 11:17:24 -0400526 printf("Read %zu bytes from volume %s to %p\n", size, volume, buf);
Stefan Agner08d4e0c2018-06-25 11:19:12 +0200527
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100528 if (vol->corrupted)
529 printf("read from corrupted volume %d", vol->vol_id);
530 if (offp + size > vol->used_bytes)
Marek Vasut40c0c8b2011-09-30 12:13:25 +0200531 size = vol->used_bytes - offp;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100532
533 tbuf_size = vol->usable_leb_size;
534 if (size < tbuf_size)
535 tbuf_size = ALIGN(size, ubi->min_io_size);
Marcel Ziswilerabc574b2015-08-18 13:06:37 +0200536 tbuf = malloc_cache_aligned(tbuf_size);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100537 if (!tbuf) {
538 printf("NO MEM\n");
Stefan Roese8cfc6962011-03-14 14:34:21 +0100539 return ENOMEM;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100540 }
541 len = size > tbuf_size ? tbuf_size : size;
542
543 tmp = offp;
544 off = do_div(tmp, vol->usable_leb_size);
545 lnum = tmp;
Holger Denglera14912b2017-08-30 18:38:52 +0200546 len_read = size;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100547 do {
548 if (off + len >= vol->usable_leb_size)
549 len = vol->usable_leb_size - off;
550
551 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
552 if (err) {
553 printf("read err %x\n", err);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100554 err = -err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100555 break;
556 }
557 off += len;
558 if (off == vol->usable_leb_size) {
559 lnum += 1;
560 off -= vol->usable_leb_size;
561 }
562
563 size -= len;
564 offp += len;
565
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100566 memcpy(buf, tbuf, len);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100567
568 buf += len;
569 len = size > tbuf_size ? tbuf_size : size;
570 } while (size);
571
Holger Denglera14912b2017-08-30 18:38:52 +0200572 if (!size)
573 env_set_hex("filesize", len_read);
574
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100575 free(tbuf);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100576 return err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100577}
578
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200579static int ubi_dev_scan(struct mtd_info *info, const char *vid_header_offset)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100580{
Simon Kagstrom4a8fbfb2009-07-07 16:59:46 +0200581 char ubi_mtd_param_buffer[80];
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100582 int err;
583
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200584 if (!vid_header_offset)
585 sprintf(ubi_mtd_param_buffer, "%s", info->name);
586 else
587 sprintf(ubi_mtd_param_buffer, "%s,%s", info->name,
588 vid_header_offset);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100589
Simon Kagstrom4a8fbfb2009-07-07 16:59:46 +0200590 err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200591 if (err)
Stefan Roese8cfc6962011-03-14 14:34:21 +0100592 return -err;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100593
594 err = ubi_init();
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200595 if (err)
Stefan Roese8cfc6962011-03-14 14:34:21 +0100596 return -err;
Stefan Roese1b20eb82008-11-27 14:07:09 +0100597
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100598 return 0;
599}
600
Stefan Roese9ea77862019-09-17 09:17:53 +0200601static int ubi_set_skip_check(char *volume, bool skip_check)
602{
603 struct ubi_vtbl_record vtbl_rec;
604 struct ubi_volume *vol;
605
606 vol = ubi_find_volume(volume);
607 if (!vol)
608 return ENODEV;
609
610 printf("%sing skip_check on volume %s\n",
611 skip_check ? "Sett" : "Clear", volume);
612
613 vtbl_rec = ubi->vtbl[vol->vol_id];
614 if (skip_check) {
615 vtbl_rec.flags |= UBI_VTBL_SKIP_CRC_CHECK_FLG;
616 vol->skip_check = 1;
617 } else {
618 vtbl_rec.flags &= ~UBI_VTBL_SKIP_CRC_CHECK_FLG;
619 vol->skip_check = 0;
620 }
621
622 return ubi_change_vtbl_record(ubi, vol->vol_id, &vtbl_rec);
623}
624
Stefan Roese3d8686b2018-10-31 12:37:20 +0100625static int ubi_detach(void)
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100626{
Joe Hershberger92198452013-04-08 10:32:47 +0000627#ifdef CONFIG_CMD_UBIFS
628 /*
629 * Automatically unmount UBIFS partition when user
630 * changes the UBI device. Otherwise the following
631 * UBIFS commands will crash.
632 */
633 if (ubifs_is_mounted())
634 cmd_ubifs_umount();
635#endif
636
Joe Hershberger92198452013-04-08 10:32:47 +0000637 /*
638 * Call ubi_exit() before re-initializing the UBI subsystem
639 */
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200640 if (ubi)
Joe Hershberger92198452013-04-08 10:32:47 +0000641 ubi_exit();
Joe Hershberger92198452013-04-08 10:32:47 +0000642
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200643 ubi = NULL;
644
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200645 return 0;
646}
647
648int ubi_part(char *part_name, const char *vid_header_offset)
649{
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200650 struct mtd_info *mtd;
Martin Kurbanovfb42f602024-06-16 16:34:17 +0300651 int err;
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200652
Alexandre Besnardb0096772022-04-04 17:50:14 +0200653 if (ubi && ubi->mtd && !strcmp(ubi->mtd->name, part_name)) {
654 printf("UBI partition '%s' already selected\n", part_name);
655 return 0;
656 }
657
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200658 ubi_detach();
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200659
660 mtd_probe_devices();
661 mtd = get_mtd_device_nm(part_name);
662 if (IS_ERR(mtd)) {
Joe Hershberger92198452013-04-08 10:32:47 +0000663 printf("Partition %s not found!\n", part_name);
664 return 1;
665 }
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200666 put_mtd_device(mtd);
Joe Hershberger92198452013-04-08 10:32:47 +0000667
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200668 err = ubi_dev_scan(mtd, vid_header_offset);
Joe Hershberger92198452013-04-08 10:32:47 +0000669 if (err) {
670 printf("UBI init error %d\n", err);
Stefan Roese8a717d52018-06-26 08:12:32 +0200671 printf("Please check, if the correct MTD partition is used (size big enough?)\n");
Joe Hershberger92198452013-04-08 10:32:47 +0000672 return err;
673 }
674
675 ubi = ubi_devices[0];
676
677 return 0;
678}
679
Simon Glassed38aef2020-05-10 11:40:03 -0600680static int do_ubi(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
Joe Hershberger92198452013-04-08 10:32:47 +0000681{
Martin Kurbanovfb42f602024-06-16 16:34:17 +0300682 int64_t size;
Joe Hershberger92198452013-04-08 10:32:47 +0000683 ulong addr = 0;
Quentin Schulza88049b2019-09-12 16:41:01 +0200684 bool skipcheck = false;
Joe Hershberger92198452013-04-08 10:32:47 +0000685
686 if (argc < 2)
687 return CMD_RET_USAGE;
Andreas Huber7bf15f82009-04-02 17:15:34 +0200688
Heinrich Schuchardte7bfcff2019-01-06 12:26:28 +0100689 if (strcmp(argv[1], "detach") == 0)
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200690 return ubi_detach();
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200691
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100692 if (strcmp(argv[1], "part") == 0) {
Simon Kagstrom4a8fbfb2009-07-07 16:59:46 +0200693 const char *vid_header_offset = NULL;
Stefan Roese62eafb72009-04-24 20:24:19 +0200694
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100695 /* Print current partition */
696 if (argc == 2) {
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200697 if (!ubi) {
698 printf("Error, no UBI device selected!\n");
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100699 return 1;
700 }
701
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200702 printf("Device %d: %s, MTD partition %s\n",
703 ubi->ubi_num, ubi->ubi_name, ubi->mtd->name);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100704 return 0;
705 }
706
Wolfgang Denk3b683112010-07-17 01:06:04 +0200707 if (argc < 3)
Simon Glassa06dfc72011-12-10 08:44:01 +0000708 return CMD_RET_USAGE;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100709
Simon Kagstrom4a8fbfb2009-07-07 16:59:46 +0200710 if (argc > 3)
711 vid_header_offset = argv[3];
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100712
Joe Hershberger92198452013-04-08 10:32:47 +0000713 return ubi_part(argv[2], vid_header_offset);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100714 }
715
Miquel Raynal12f1ff12018-09-29 12:58:29 +0200716 if ((strcmp(argv[1], "part") != 0) && !ubi) {
717 printf("Error, no UBI device selected!\n");
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100718 return 1;
719 }
720
721 if (strcmp(argv[1], "info") == 0) {
722 int layout = 0;
723 if (argc > 2 && !strncmp(argv[2], "l", 1))
724 layout = 1;
725 return ubi_info(layout);
726 }
727
Pali Rohár9395eb92022-09-12 11:38:55 +0200728 if (strcmp(argv[1], "list") == 0) {
729 int numeric = 0;
Dmitry Dunaev3c72eca2023-07-12 15:58:21 +0300730 if (argc >= 3 && argv[2][0] == '-') {
Pali Rohár9395eb92022-09-12 11:38:55 +0200731 if (strcmp(argv[2], "-numeric") == 0)
732 numeric = 1;
733 else
734 return CMD_RET_USAGE;
735 }
736 if (!numeric && argc != 2 && argc != 3)
737 return CMD_RET_USAGE;
738 if (numeric && argc != 3 && argc != 4)
739 return CMD_RET_USAGE;
740 return ubi_list(argv[numeric ? 3 : 2], numeric);
741 }
742
Heiko Schocher1762ab12014-01-25 07:27:11 +0100743 if (strcmp(argv[1], "check") == 0) {
744 if (argc > 2)
745 return ubi_check(argv[2]);
746
747 printf("Error, no volume name passed\n");
748 return 1;
749 }
750
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100751 if (strncmp(argv[1], "create", 6) == 0) {
752 int dynamic = 1; /* default: dynamic volume */
Ladislav Michl39370f12016-09-13 07:14:01 +0200753 int id = UBI_VOL_NUM_AUTO;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100754
755 /* Use maximum available size */
756 size = 0;
757
Quentin Schulza88049b2019-09-12 16:41:01 +0200758 /* E.g., create volume with "skipcheck" bit set */
759 if (argc == 7) {
760 skipcheck = strncmp(argv[6], "--skipcheck", 11) == 0;
761 argc--;
762 }
763
Ladislav Michl39370f12016-09-13 07:14:01 +0200764 /* E.g., create volume size type vol_id */
765 if (argc == 6) {
766 id = simple_strtoull(argv[5], NULL, 16);
767 argc--;
768 }
769
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100770 /* E.g., create volume size type */
771 if (argc == 5) {
772 if (strncmp(argv[4], "s", 1) == 0)
773 dynamic = 0;
774 else if (strncmp(argv[4], "d", 1) != 0) {
775 printf("Incorrect type\n");
776 return 1;
777 }
778 argc--;
779 }
780 /* E.g., create volume size */
781 if (argc == 4) {
Ladislav Michl4fb937b2017-01-19 11:45:35 +0100782 if (argv[3][0] != '-')
783 size = simple_strtoull(argv[3], NULL, 16);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100784 argc--;
785 }
786 /* Use maximum available size */
Stefan Roese8cfc6962011-03-14 14:34:21 +0100787 if (!size) {
Paul Burtondf686162013-09-04 15:16:58 +0100788 size = (int64_t)ubi->avail_pebs * ubi->leb_size;
789 printf("No size specified -> Using max size (%lld)\n", size);
Stefan Roese8cfc6962011-03-14 14:34:21 +0100790 }
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100791 /* E.g., create volume */
Quentin Schulza88049b2019-09-12 16:41:01 +0200792 if (argc == 3) {
793 return ubi_create_vol(argv[2], size, dynamic, id,
794 skipcheck);
795 }
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100796 }
797
798 if (strncmp(argv[1], "remove", 6) == 0) {
799 /* E.g., remove volume */
800 if (argc == 3)
801 return ubi_remove_vol(argv[2]);
802 }
803
Philippe Reynes10d53222020-03-23 19:20:47 +0100804 if (IS_ENABLED(CONFIG_CMD_UBI_RENAME) && !strncmp(argv[1], "rename", 6))
805 return ubi_rename_vol(argv[2], argv[3]);
806
Stefan Roese9ea77862019-09-17 09:17:53 +0200807 if (strncmp(argv[1], "skipcheck", 9) == 0) {
808 /* E.g., change skip_check flag */
809 if (argc == 4) {
810 skipcheck = strncmp(argv[3], "on", 2) == 0;
811 return ubi_set_skip_check(argv[2], skipcheck);
812 }
813 }
814
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100815 if (strncmp(argv[1], "write", 5) == 0) {
Joe Hershberger92198452013-04-08 10:32:47 +0000816 int ret;
817
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100818 if (argc < 5) {
819 printf("Please see usage\n");
820 return 1;
821 }
822
Simon Glass3ff49ec2021-07-24 09:03:29 -0600823 addr = hextoul(argv[2], NULL);
824 size = hextoul(argv[4], NULL);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100825
Paul Burton6627aa32013-09-04 15:16:59 +0100826 if (strlen(argv[1]) == 10 &&
827 strncmp(argv[1] + 5, ".part", 5) == 0) {
828 if (argc < 6) {
829 ret = ubi_volume_continue_write(argv[3],
830 (void *)addr, size);
831 } else {
832 size_t full_size;
Simon Glass3ff49ec2021-07-24 09:03:29 -0600833 full_size = hextoul(argv[5], NULL);
Paul Burton6627aa32013-09-04 15:16:59 +0100834 ret = ubi_volume_begin_write(argv[3],
835 (void *)addr, size, full_size);
836 }
837 } else {
Alexey Romanovde417e92024-07-18 08:45:24 +0300838 ret = ubi_volume_write(argv[3], (void *)addr, 0, size);
Paul Burton6627aa32013-09-04 15:16:59 +0100839 }
Joe Hershberger92198452013-04-08 10:32:47 +0000840 if (!ret) {
Paul Burtondf686162013-09-04 15:16:58 +0100841 printf("%lld bytes written to volume %s\n", size,
Joe Hershberger92198452013-04-08 10:32:47 +0000842 argv[3]);
843 }
844
845 return ret;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100846 }
847
848 if (strncmp(argv[1], "read", 4) == 0) {
849 size = 0;
850
851 /* E.g., read volume size */
852 if (argc == 5) {
Simon Glass3ff49ec2021-07-24 09:03:29 -0600853 size = hextoul(argv[4], NULL);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100854 argc--;
855 }
856
857 /* E.g., read volume */
858 if (argc == 4) {
Simon Glass3ff49ec2021-07-24 09:03:29 -0600859 addr = hextoul(argv[2], NULL);
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100860 argc--;
861 }
862
Joe Hershberger92198452013-04-08 10:32:47 +0000863 if (argc == 3) {
Alexey Romanov0043a972024-07-18 08:45:23 +0300864 return ubi_volume_read(argv[3], (char *)addr, 0, size);
Joe Hershberger92198452013-04-08 10:32:47 +0000865 }
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100866 }
867
868 printf("Please see usage\n");
Stefan Roese8cfc6962011-03-14 14:34:21 +0100869 return 1;
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100870}
871
Frans Meulenbroeks7675a092010-07-31 15:01:53 +0200872U_BOOT_CMD(
Quentin Schulza88049b2019-09-12 16:41:01 +0200873 ubi, 7, 1, do_ubi,
Peter Tyserdfb72b82009-01-27 18:03:12 -0600874 "ubi commands",
Heiko Schocher8b4b05f2016-06-07 08:55:40 +0200875 "detach"
876 " - detach ubi from a mtd partition\n"
877 "ubi part [part] [offset]\n"
Simon Kagstrom4a8fbfb2009-07-07 16:59:46 +0200878 " - Show or set current partition (with optional VID"
879 " header offset)\n"
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100880 "ubi info [l[ayout]]"
881 " - Display volume and ubi layout information\n"
Pali Rohár9395eb92022-09-12 11:38:55 +0200882 "ubi list [flags]"
883 " - print the list of volumes\n"
884 "ubi list [flags] <varname>"
885 " - set environment variable to the list of volumes"
886 " (flags can be -numeric)\n"
Heiko Schocher1762ab12014-01-25 07:27:11 +0100887 "ubi check volumename"
888 " - check if volumename exists\n"
Quentin Schulza88049b2019-09-12 16:41:01 +0200889 "ubi create[vol] volume [size] [type] [id] [--skipcheck]\n"
Ladislav Michl4fb937b2017-01-19 11:45:35 +0100890 " - create volume name with size ('-' for maximum"
891 " available size)\n"
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100892 "ubi write[vol] address volume size"
893 " - Write volume from address with size\n"
Paul Burton6627aa32013-09-04 15:16:59 +0100894 "ubi write.part address volume size [fullsize]\n"
895 " - Write part of a volume from address\n"
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100896 "ubi read[vol] address volume [size]"
897 " - Read volume to address with size\n"
898 "ubi remove[vol] volume"
899 " - Remove volume\n"
Philippe Reynes10d53222020-03-23 19:20:47 +0100900#if IS_ENABLED(CONFIG_CMD_UBI_RENAME)
901 "ubi rename oldname newname\n"
902#endif
Stefan Roese9ea77862019-09-17 09:17:53 +0200903 "ubi skipcheck volume on/off - Set or clear skip_check flag in volume header\n"
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100904 "[Legends]\n"
Andrzej Wolski7dcc1702009-07-17 22:26:54 +0200905 " volume: character name\n"
906 " size: specified in bytes\n"
Wolfgang Denkc54781c2009-05-24 17:06:54 +0200907 " type: s[tatic] or d[ynamic] (default=dynamic)"
Kyungmin Park3d2c5ff2008-11-19 11:47:05 +0100908);