]> git.ipfire.org Git - thirdparty/u-boot.git/blame - drivers/dfu/dfu_mtd.c
Revert "Merge patch series "arm: dts: am62-beagleplay: Fix Beagleplay Ethernet""
[thirdparty/u-boot.git] / drivers / dfu / dfu_mtd.c
CommitLineData
6015af28
PD
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * dfu_mtd.c -- DFU for MTD device.
4 *
5 * Copyright (C) 2019,STMicroelectronics - All Rights Reserved
6 *
7 * Based on dfu_nand.c
8 */
9
d678a59d 10#include <common.h>
6015af28
PD
11#include <dfu.h>
12#include <mtd.h>
61b29b82 13#include <linux/err.h>
8db74c15 14#include <linux/ctype.h>
6015af28
PD
15
16static bool mtd_is_aligned_with_block_size(struct mtd_info *mtd, u64 size)
17{
18 return !do_div(size, mtd->erasesize);
19}
20
56227473
PD
21/* Logic taken from cmd/mtd.c:mtd_oob_write_is_empty() */
22static bool mtd_page_is_empty(struct mtd_oob_ops *op)
23{
24 int i;
25
26 for (i = 0; i < op->len; i++)
27 if (op->datbuf[i] != 0xff)
28 return false;
29
30 /* oob is not used, with MTD_OPS_AUTO_OOB & ooblen=0 */
31
32 return true;
33}
34
6015af28
PD
35static int mtd_block_op(enum dfu_op op, struct dfu_entity *dfu,
36 u64 offset, void *buf, long *len)
37{
65f3fc18 38 u64 off, lim, remaining, lock_ofs, lock_len;
6015af28
PD
39 struct mtd_info *mtd = dfu->data.mtd.info;
40 struct mtd_oob_ops io_op = {};
41 int ret = 0;
42 bool has_pages = mtd->type == MTD_NANDFLASH ||
43 mtd->type == MTD_MLCNANDFLASH;
44
45 /* if buf == NULL return total size of the area */
46 if (!buf) {
47 *len = dfu->data.mtd.size;
48 return 0;
49 }
50
65f3fc18 51 off = lock_ofs = dfu->data.mtd.start + offset + dfu->bad_skip;
6015af28
PD
52 lim = dfu->data.mtd.start + dfu->data.mtd.size;
53
54 if (off >= lim) {
55 printf("Limit reached 0x%llx\n", lim);
56 *len = 0;
57 return op == DFU_OP_READ ? 0 : -EIO;
58 }
59 /* limit request with the available size */
60 if (off + *len >= lim)
61 *len = lim - off;
62
63 if (!mtd_is_aligned_with_block_size(mtd, off)) {
64 printf("Offset not aligned with a block (0x%x)\n",
65 mtd->erasesize);
66 return 0;
67 }
68
69 /* first erase */
70 if (op == DFU_OP_WRITE) {
71 struct erase_info erase_op = {};
72
65f3fc18 73 remaining = lock_len = round_up(*len, mtd->erasesize);
6015af28
PD
74 erase_op.mtd = mtd;
75 erase_op.addr = off;
76 erase_op.len = mtd->erasesize;
77 erase_op.scrub = 0;
78
65f3fc18
SG
79 debug("Unlocking the mtd device\n");
80 ret = mtd_unlock(mtd, lock_ofs, lock_len);
81 if (ret && ret != -EOPNOTSUPP) {
82 printf("MTD device unlock failed\n");
83 return 0;
84 }
85
6015af28
PD
86 while (remaining) {
87 if (erase_op.addr + remaining > lim) {
4b1c067e
PD
88 printf("Limit reached 0x%llx while erasing at offset 0x%llx, remaining 0x%llx\n",
89 lim, erase_op.addr, remaining);
6015af28
PD
90 return -EIO;
91 }
92
be0da125
PD
93 /* Skip the block if it is bad, don't erase it again */
94 ret = mtd_block_isbad(mtd, erase_op.addr);
95 if (ret) {
96 printf("Skipping %s at 0x%08llx\n",
97 ret == 1 ? "bad block" : "bbt reserved",
98 erase_op.addr);
99 erase_op.addr += mtd->erasesize;
100 continue;
101 }
102
6015af28
PD
103 ret = mtd_erase(mtd, &erase_op);
104
105 if (ret) {
be0da125
PD
106 /* If this is not -EIO, we have no idea what to do. */
107 if (ret == -EIO) {
108 printf("Marking bad block at 0x%08llx (%d)\n",
109 erase_op.fail_addr, ret);
110 ret = mtd_block_markbad(mtd, erase_op.addr);
111 }
112 /* Abort if it is not -EIO or can't mark bad */
113 if (ret) {
114 printf("Failure while erasing at offset 0x%llx (%d)\n",
115 erase_op.fail_addr, ret);
116 return ret;
6015af28 117 }
6015af28
PD
118 } else {
119 remaining -= mtd->erasesize;
120 }
121
be0da125 122 /* Continue erase behind the current block */
6015af28
PD
123 erase_op.addr += mtd->erasesize;
124 }
125 }
126
127 io_op.mode = MTD_OPS_AUTO_OOB;
128 io_op.len = *len;
129 if (has_pages && io_op.len > mtd->writesize)
130 io_op.len = mtd->writesize;
131 io_op.ooblen = 0;
132 io_op.datbuf = buf;
133 io_op.oobbuf = NULL;
134
135 /* Loop over to do the actual read/write */
136 remaining = *len;
137 while (remaining) {
138 if (off + remaining > lim) {
139 printf("Limit reached 0x%llx while %s at offset 0x%llx\n",
140 lim, op == DFU_OP_READ ? "reading" : "writing",
141 off);
142 if (op == DFU_OP_READ) {
143 *len -= remaining;
144 return 0;
145 } else {
146 return -EIO;
147 }
148 }
149
150 /* Skip the block if it is bad */
151 if (mtd_is_aligned_with_block_size(mtd, off) &&
152 mtd_block_isbad(mtd, off)) {
153 off += mtd->erasesize;
154 dfu->bad_skip += mtd->erasesize;
155 continue;
156 }
157
158 if (op == DFU_OP_READ)
159 ret = mtd_read_oob(mtd, off, &io_op);
56227473
PD
160 else if (has_pages && dfu->data.mtd.ubi && mtd_page_is_empty(&io_op)) {
161 /* in case of ubi partition, do not write an empty page, only skip it */
162 ret = 0;
163 io_op.retlen = mtd->writesize;
164 io_op.oobretlen = mtd->oobsize;
165 } else {
6015af28 166 ret = mtd_write_oob(mtd, off, &io_op);
56227473 167 }
6015af28
PD
168
169 if (ret) {
170 printf("Failure while %s at offset 0x%llx\n",
171 op == DFU_OP_READ ? "reading" : "writing", off);
172 return -EIO;
173 }
174
175 off += io_op.retlen;
176 remaining -= io_op.retlen;
177 io_op.datbuf += io_op.retlen;
178 io_op.len = remaining;
179 if (has_pages && io_op.len > mtd->writesize)
180 io_op.len = mtd->writesize;
181 }
182
65f3fc18
SG
183 if (op == DFU_OP_WRITE) {
184 /* Write done, lock again */
185 debug("Locking the mtd device\n");
186 ret = mtd_lock(mtd, lock_ofs, lock_len);
a5bb384c
PD
187 if (ret == -EOPNOTSUPP)
188 ret = 0;
189 else if (ret)
65f3fc18
SG
190 printf("MTD device lock failed\n");
191 }
6015af28
PD
192 return ret;
193}
194
195static int dfu_get_medium_size_mtd(struct dfu_entity *dfu, u64 *size)
196{
197 *size = dfu->data.mtd.info->size;
198
199 return 0;
200}
201
202static int dfu_read_medium_mtd(struct dfu_entity *dfu, u64 offset, void *buf,
203 long *len)
204{
205 int ret = -1;
206
207 switch (dfu->layout) {
208 case DFU_RAW_ADDR:
209 ret = mtd_block_op(DFU_OP_READ, dfu, offset, buf, len);
210 break;
211 default:
212 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
213 dfu_get_layout(dfu->layout));
214 }
215
216 return ret;
217}
218
219static int dfu_write_medium_mtd(struct dfu_entity *dfu,
220 u64 offset, void *buf, long *len)
221{
222 int ret = -1;
223
224 switch (dfu->layout) {
225 case DFU_RAW_ADDR:
226 ret = mtd_block_op(DFU_OP_WRITE, dfu, offset, buf, len);
227 break;
228 default:
229 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
230 dfu_get_layout(dfu->layout));
231 }
232
233 return ret;
234}
235
236static int dfu_flush_medium_mtd(struct dfu_entity *dfu)
237{
d5640f70
PD
238 struct mtd_info *mtd = dfu->data.mtd.info;
239 u64 remaining;
240 int ret;
241
242 /* in case of ubi partition, erase rest of the partition */
1b3c4cb1 243 if (dfu->data.mtd.ubi) {
d5640f70
PD
244 struct erase_info erase_op = {};
245
246 erase_op.mtd = dfu->data.mtd.info;
247 erase_op.addr = round_up(dfu->data.mtd.start + dfu->offset +
248 dfu->bad_skip, mtd->erasesize);
249 erase_op.len = mtd->erasesize;
250 erase_op.scrub = 0;
251
252 remaining = dfu->data.mtd.start + dfu->data.mtd.size -
253 erase_op.addr;
254
255 while (remaining) {
256 ret = mtd_erase(mtd, &erase_op);
257
258 if (ret) {
259 /* Abort if its not a bad block error */
260 if (ret != -EIO)
261 break;
262 printf("Skipping bad block at 0x%08llx\n",
263 erase_op.addr);
264 }
265
266 /* Skip bad block and continue behind it */
267 erase_op.addr += mtd->erasesize;
268 remaining -= mtd->erasesize;
269 }
270 }
6015af28
PD
271 return 0;
272}
273
274static unsigned int dfu_polltimeout_mtd(struct dfu_entity *dfu)
275{
d5640f70
PD
276 /*
277 * Currently, Poll Timeout != 0 is only needed on nand
278 * ubi partition, as sectors which are not used need
279 * to be erased
280 */
1b3c4cb1 281 if (dfu->data.mtd.ubi)
d5640f70
PD
282 return DFU_MANIFEST_POLL_TIMEOUT;
283
6015af28
PD
284 return DFU_DEFAULT_POLL_TIMEOUT;
285}
286
53b40636 287int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char **argv, int argc)
6015af28 288{
53b40636 289 char *s;
6015af28 290 struct mtd_info *mtd;
28d3439f 291 int part;
6015af28
PD
292
293 mtd = get_mtd_device_nm(devstr);
294 if (IS_ERR_OR_NULL(mtd))
295 return -ENODEV;
296 put_mtd_device(mtd);
297
298 dfu->dev_type = DFU_DEV_MTD;
299 dfu->data.mtd.info = mtd;
2dc41fcc 300 dfu->max_buf_size = mtd->erasesize;
53b40636
MH
301 if (argc < 1)
302 return -EINVAL;
6015af28 303
53b40636
MH
304 if (!strcmp(argv[0], "raw")) {
305 if (argc != 3)
306 return -EINVAL;
6015af28 307 dfu->layout = DFU_RAW_ADDR;
53b40636
MH
308 dfu->data.mtd.start = hextoul(argv[1], &s);
309 if (*s)
310 return -EINVAL;
311 dfu->data.mtd.size = hextoul(argv[2], &s);
312 if (*s)
313 return -EINVAL;
314 } else if ((!strcmp(argv[0], "part")) || (!strcmp(argv[0], "partubi"))) {
28d3439f
PD
315 struct mtd_info *partition;
316 int partnum = 0;
317 bool part_found = false;
d5640f70 318
53b40636
MH
319 if (argc != 2)
320 return -EINVAL;
321
d5640f70
PD
322 dfu->layout = DFU_RAW_ADDR;
323
53b40636
MH
324 part = dectoul(argv[1], &s);
325 if (*s)
326 return -EINVAL;
d5640f70 327
28d3439f
PD
328 /* register partitions with MTDIDS/MTDPARTS or OF fallback */
329 mtd_probe_devices();
d5640f70 330
28d3439f
PD
331 partnum = 0;
332 list_for_each_entry(partition, &mtd->partitions, node) {
333 partnum++;
334 if (partnum == part) {
335 part_found = true;
336 break;
337 }
338 }
339 if (!part_found) {
340 printf("No partition %d in %s\n", part, mtd->name);
d5640f70
PD
341 return -1;
342 }
28d3439f 343 log_debug("partition %d:%s in %s\n", partnum, partition->name, mtd->name);
d5640f70 344
28d3439f
PD
345 dfu->data.mtd.start = partition->offset;
346 dfu->data.mtd.size = partition->size;
53b40636 347 if (!strcmp(argv[0], "partubi"))
d5640f70 348 dfu->data.mtd.ubi = 1;
6015af28 349 } else {
53b40636 350 printf("%s: Memory layout (%s) not supported!\n", __func__, argv[0]);
6015af28
PD
351 return -1;
352 }
353
d5640f70
PD
354 if (!mtd_is_aligned_with_block_size(mtd, dfu->data.mtd.start)) {
355 printf("Offset not aligned with a block (0x%x)\n",
356 mtd->erasesize);
357 return -EINVAL;
358 }
359 if (!mtd_is_aligned_with_block_size(mtd, dfu->data.mtd.size)) {
360 printf("Size not aligned with a block (0x%x)\n",
361 mtd->erasesize);
362 return -EINVAL;
363 }
364
6015af28
PD
365 dfu->get_medium_size = dfu_get_medium_size_mtd;
366 dfu->read_medium = dfu_read_medium_mtd;
367 dfu->write_medium = dfu_write_medium_mtd;
368 dfu->flush_medium = dfu_flush_medium_mtd;
369 dfu->poll_timeout = dfu_polltimeout_mtd;
370
371 /* initial state */
372 dfu->inited = 0;
373
374 return 0;
375}