blob: b9000563b9f4311d63ffdfe66ba5166eb158b482 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * MTD device concatenation layer
3 *
David Woodhousea1452a32010-08-08 20:58:20 +01004 * Copyright © 2002 Robert Kaiser <rkaiser@sysgo.de>
5 * Copyright © 2002-2010 David Woodhouse <dwmw2@infradead.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
7 * NAND support by Christian Gan <cgan@iders.ca>
8 *
David Woodhousea1452a32010-08-08 20:58:20 +01009 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 */
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/kernel.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010026#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010028#include <linux/sched.h>
29#include <linux/types.h>
David Howells6e232cf2009-02-12 10:40:05 +000030#include <linux/backing-dev.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/mtd/mtd.h>
33#include <linux/mtd/concat.h>
34
Andrew Morton6c8b44a2006-05-20 10:17:21 +010035#include <asm/div64.h>
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
38 * Our storage structure:
39 * Subdev points to an array of pointers to struct mtd_info objects
40 * which is allocated along with this structure
41 *
42 */
43struct mtd_concat {
44 struct mtd_info mtd;
45 int num_subdev;
46 struct mtd_info **subdev;
47};
48
49/*
50 * how to calculate the size required for the above structure,
51 * including the pointer array subdev points to:
52 */
53#define SIZEOF_STRUCT_MTD_CONCAT(num_subdev) \
54 ((sizeof(struct mtd_concat) + (num_subdev) * sizeof(struct mtd_info *)))
55
56/*
57 * Given a pointer to the MTD object in the mtd_concat structure,
58 * we can retrieve the pointer to that structure with this macro.
59 */
60#define CONCAT(x) ((struct mtd_concat *)(x))
61
Thomas Gleixner97894cd2005-11-07 11:15:26 +000062/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * MTD methods which look up the relevant subdevice, translate the
64 * effective address and pass through to the subdevice.
65 */
66
67static int
68concat_read(struct mtd_info *mtd, loff_t from, size_t len,
69 size_t * retlen, u_char * buf)
70{
71 struct mtd_concat *concat = CONCAT(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020072 int ret = 0, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 int i;
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 for (i = 0; i < concat->num_subdev; i++) {
76 struct mtd_info *subdev = concat->subdev[i];
77 size_t size, retsize;
78
79 if (from >= subdev->size) {
80 /* Not destined for this subdev */
81 size = 0;
82 from -= subdev->size;
83 continue;
84 }
85 if (from + len > subdev->size)
86 /* First part goes into this subdev */
87 size = subdev->size - from;
88 else
89 /* Entire transaction goes into this subdev */
90 size = len;
91
Artem Bityutskiy329ad392011-12-23 17:30:16 +020092 err = mtd_read(subdev, from, size, &retsize, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +020094 /* Save information about bitflips! */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020095 if (unlikely(err)) {
Brian Norrisd57f40542011-09-20 18:34:25 -070096 if (mtd_is_eccerr(err)) {
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020097 mtd->ecc_stats.failed++;
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +020098 ret = err;
Brian Norrisd57f40542011-09-20 18:34:25 -070099 } else if (mtd_is_bitflip(err)) {
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200100 mtd->ecc_stats.corrected++;
101 /* Do not overwrite -EBADMSG !! */
102 if (!ret)
103 ret = err;
104 } else
105 return err;
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200106 }
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 *retlen += retsize;
109 len -= size;
110 if (len == 0)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200111 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 buf += size;
114 from = 0;
115 }
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200116 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117}
118
119static int
120concat_write(struct mtd_info *mtd, loff_t to, size_t len,
121 size_t * retlen, const u_char * buf)
122{
123 struct mtd_concat *concat = CONCAT(mtd);
124 int err = -EINVAL;
125 int i;
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 for (i = 0; i < concat->num_subdev; i++) {
128 struct mtd_info *subdev = concat->subdev[i];
129 size_t size, retsize;
130
131 if (to >= subdev->size) {
132 size = 0;
133 to -= subdev->size;
134 continue;
135 }
136 if (to + len > subdev->size)
137 size = subdev->size - to;
138 else
139 size = len;
140
Artem Bityutskiy664addc2012-02-03 18:13:23 +0200141 err = mtd_write(subdev, to, size, &retsize, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 if (err)
143 break;
144
145 *retlen += retsize;
146 len -= size;
147 if (len == 0)
148 break;
149
150 err = -EINVAL;
151 buf += size;
152 to = 0;
153 }
154 return err;
155}
156
157static int
Thomas Gleixner9d8522d2006-05-23 16:06:03 +0200158concat_writev(struct mtd_info *mtd, const struct kvec *vecs,
159 unsigned long count, loff_t to, size_t * retlen)
Alexander Belyakove8d32932006-05-17 19:11:16 +0400160{
161 struct mtd_concat *concat = CONCAT(mtd);
162 struct kvec *vecs_copy;
163 unsigned long entry_low, entry_high;
164 size_t total_len = 0;
165 int i;
166 int err = -EINVAL;
167
Alexander Belyakove8d32932006-05-17 19:11:16 +0400168 /* Calculate total length of data */
169 for (i = 0; i < count; i++)
170 total_len += vecs[i].iov_len;
171
Alexander Belyakove8d32932006-05-17 19:11:16 +0400172 /* Check alignment */
Joern Engel28318772006-05-22 23:18:05 +0200173 if (mtd->writesize > 1) {
David Woodhouse0bf97332007-07-23 13:07:06 +0100174 uint64_t __to = to;
Joern Engel28318772006-05-22 23:18:05 +0200175 if (do_div(__to, mtd->writesize) || (total_len % mtd->writesize))
Alexander Belyakove8d32932006-05-17 19:11:16 +0400176 return -EINVAL;
Andrew Morton6c8b44a2006-05-20 10:17:21 +0100177 }
Alexander Belyakove8d32932006-05-17 19:11:16 +0400178
179 /* make a copy of vecs */
Julia Lawalld80f2662010-05-15 23:23:31 +0200180 vecs_copy = kmemdup(vecs, sizeof(struct kvec) * count, GFP_KERNEL);
Alexander Belyakove8d32932006-05-17 19:11:16 +0400181 if (!vecs_copy)
182 return -ENOMEM;
Alexander Belyakove8d32932006-05-17 19:11:16 +0400183
184 entry_low = 0;
185 for (i = 0; i < concat->num_subdev; i++) {
186 struct mtd_info *subdev = concat->subdev[i];
187 size_t size, wsize, retsize, old_iov_len;
188
189 if (to >= subdev->size) {
190 to -= subdev->size;
191 continue;
192 }
193
Adrian Hunter69423d92008-12-10 13:37:21 +0000194 size = min_t(uint64_t, total_len, subdev->size - to);
Alexander Belyakove8d32932006-05-17 19:11:16 +0400195 wsize = size; /* store for future use */
196
197 entry_high = entry_low;
198 while (entry_high < count) {
199 if (size <= vecs_copy[entry_high].iov_len)
200 break;
201 size -= vecs_copy[entry_high++].iov_len;
202 }
203
204 old_iov_len = vecs_copy[entry_high].iov_len;
205 vecs_copy[entry_high].iov_len = size;
206
Artem Bityutskiy664addc2012-02-03 18:13:23 +0200207 err = mtd_writev(subdev, &vecs_copy[entry_low],
208 entry_high - entry_low + 1, to, &retsize);
Alexander Belyakove8d32932006-05-17 19:11:16 +0400209
210 vecs_copy[entry_high].iov_len = old_iov_len - size;
211 vecs_copy[entry_high].iov_base += size;
212
213 entry_low = entry_high;
214
215 if (err)
216 break;
217
218 *retlen += retsize;
219 total_len -= wsize;
Alexander Belyakove8d32932006-05-17 19:11:16 +0400220
221 if (total_len == 0)
222 break;
223
224 err = -EINVAL;
225 to = 0;
226 }
227
228 kfree(vecs_copy);
229 return err;
230}
231
232static int
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200233concat_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 struct mtd_concat *concat = CONCAT(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200236 struct mtd_oob_ops devops = *ops;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200237 int i, err, ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Vitaly Wool70145682006-11-03 18:20:38 +0300239 ops->retlen = ops->oobretlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241 for (i = 0; i < concat->num_subdev; i++) {
242 struct mtd_info *subdev = concat->subdev[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244 if (from >= subdev->size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 from -= subdev->size;
246 continue;
247 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200249 /* partial read ? */
250 if (from + devops.len > subdev->size)
251 devops.len = subdev->size - from;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200253 err = mtd_read_oob(subdev, from, &devops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200254 ops->retlen += devops.retlen;
Vitaly Wool70145682006-11-03 18:20:38 +0300255 ops->oobretlen += devops.oobretlen;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200256
257 /* Save information about bitflips! */
258 if (unlikely(err)) {
Brian Norrisd57f40542011-09-20 18:34:25 -0700259 if (mtd_is_eccerr(err)) {
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200260 mtd->ecc_stats.failed++;
261 ret = err;
Brian Norrisd57f40542011-09-20 18:34:25 -0700262 } else if (mtd_is_bitflip(err)) {
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200263 mtd->ecc_stats.corrected++;
264 /* Do not overwrite -EBADMSG !! */
265 if (!ret)
266 ret = err;
267 } else
268 return err;
269 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Vitaly Wool70145682006-11-03 18:20:38 +0300271 if (devops.datbuf) {
272 devops.len = ops->len - ops->retlen;
273 if (!devops.len)
274 return ret;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200275 devops.datbuf += devops.retlen;
Vitaly Wool70145682006-11-03 18:20:38 +0300276 }
277 if (devops.oobbuf) {
278 devops.ooblen = ops->ooblen - ops->oobretlen;
279 if (!devops.ooblen)
280 return ret;
281 devops.oobbuf += ops->oobretlen;
282 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 from = 0;
285 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200286 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287}
288
289static int
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200290concat_write_oob(struct mtd_info *mtd, loff_t to, struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291{
292 struct mtd_concat *concat = CONCAT(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200293 struct mtd_oob_ops devops = *ops;
294 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296 if (!(mtd->flags & MTD_WRITEABLE))
297 return -EROFS;
298
Felix Radensky431e1ec2011-04-25 01:57:12 +0300299 ops->retlen = ops->oobretlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 for (i = 0; i < concat->num_subdev; i++) {
302 struct mtd_info *subdev = concat->subdev[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 if (to >= subdev->size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 to -= subdev->size;
306 continue;
307 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200309 /* partial write ? */
310 if (to + devops.len > subdev->size)
311 devops.len = subdev->size - to;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200313 err = mtd_write_oob(subdev, to, &devops);
Felix Radensky431e1ec2011-04-25 01:57:12 +0300314 ops->retlen += devops.oobretlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 if (err)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200316 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Vitaly Wool70145682006-11-03 18:20:38 +0300318 if (devops.datbuf) {
319 devops.len = ops->len - ops->retlen;
320 if (!devops.len)
321 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200322 devops.datbuf += devops.retlen;
Vitaly Wool70145682006-11-03 18:20:38 +0300323 }
324 if (devops.oobbuf) {
325 devops.ooblen = ops->ooblen - ops->oobretlen;
326 if (!devops.ooblen)
327 return 0;
328 devops.oobbuf += devops.oobretlen;
329 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 to = 0;
331 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200332 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333}
334
335static void concat_erase_callback(struct erase_info *instr)
336{
337 wake_up((wait_queue_head_t *) instr->priv);
338}
339
340static int concat_dev_erase(struct mtd_info *mtd, struct erase_info *erase)
341{
342 int err;
343 wait_queue_head_t waitq;
344 DECLARE_WAITQUEUE(wait, current);
345
346 /*
347 * This code was stol^H^H^H^Hinspired by mtdchar.c
348 */
349 init_waitqueue_head(&waitq);
350
351 erase->mtd = mtd;
352 erase->callback = concat_erase_callback;
353 erase->priv = (unsigned long) &waitq;
354
355 /*
356 * FIXME: Allow INTERRUPTIBLE. Which means
357 * not having the wait_queue head on the stack.
358 */
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200359 err = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 if (!err) {
361 set_current_state(TASK_UNINTERRUPTIBLE);
362 add_wait_queue(&waitq, &wait);
363 if (erase->state != MTD_ERASE_DONE
364 && erase->state != MTD_ERASE_FAILED)
365 schedule();
366 remove_wait_queue(&waitq, &wait);
367 set_current_state(TASK_RUNNING);
368
369 err = (erase->state == MTD_ERASE_FAILED) ? -EIO : 0;
370 }
371 return err;
372}
373
374static int concat_erase(struct mtd_info *mtd, struct erase_info *instr)
375{
376 struct mtd_concat *concat = CONCAT(mtd);
377 struct mtd_info *subdev;
378 int i, err;
Adrian Hunter69423d92008-12-10 13:37:21 +0000379 uint64_t length, offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 struct erase_info *erase;
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 /*
383 * Check for proper erase block alignment of the to-be-erased area.
384 * It is easier to do this based on the super device's erase
385 * region info rather than looking at each particular sub-device
386 * in turn.
387 */
388 if (!concat->mtd.numeraseregions) {
389 /* the easy case: device has uniform erase block size */
390 if (instr->addr & (concat->mtd.erasesize - 1))
391 return -EINVAL;
392 if (instr->len & (concat->mtd.erasesize - 1))
393 return -EINVAL;
394 } else {
395 /* device has variable erase size */
396 struct mtd_erase_region_info *erase_regions =
397 concat->mtd.eraseregions;
398
399 /*
400 * Find the erase region where the to-be-erased area begins:
401 */
402 for (i = 0; i < concat->mtd.numeraseregions &&
403 instr->addr >= erase_regions[i].offset; i++) ;
404 --i;
405
406 /*
407 * Now erase_regions[i] is the region in which the
408 * to-be-erased area begins. Verify that the starting
409 * offset is aligned to this region's erase size:
410 */
Roel Kluinebf2e932009-09-18 12:51:49 -0700411 if (i < 0 || instr->addr & (erase_regions[i].erasesize - 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 return -EINVAL;
413
414 /*
415 * now find the erase region where the to-be-erased area ends:
416 */
417 for (; i < concat->mtd.numeraseregions &&
418 (instr->addr + instr->len) >= erase_regions[i].offset;
419 ++i) ;
420 --i;
421 /*
422 * check if the ending offset is aligned to this region's erase size
423 */
Roel Kluinebf2e932009-09-18 12:51:49 -0700424 if (i < 0 || ((instr->addr + instr->len) &
425 (erase_regions[i].erasesize - 1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return -EINVAL;
427 }
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 /* make a local copy of instr to avoid modifying the caller's struct */
430 erase = kmalloc(sizeof (struct erase_info), GFP_KERNEL);
431
432 if (!erase)
433 return -ENOMEM;
434
435 *erase = *instr;
436 length = instr->len;
437
438 /*
439 * find the subdevice where the to-be-erased area begins, adjust
440 * starting offset to be relative to the subdevice start
441 */
442 for (i = 0; i < concat->num_subdev; i++) {
443 subdev = concat->subdev[i];
444 if (subdev->size <= erase->addr) {
445 erase->addr -= subdev->size;
446 offset += subdev->size;
447 } else {
448 break;
449 }
450 }
451
452 /* must never happen since size limit has been verified above */
Eric Sesterhenn373ebfb2006-03-26 18:15:12 +0200453 BUG_ON(i >= concat->num_subdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455 /* now do the erase: */
456 err = 0;
457 for (; length > 0; i++) {
458 /* loop for all subdevices affected by this request */
459 subdev = concat->subdev[i]; /* get current subdevice */
460
461 /* limit length to subdevice's size: */
462 if (erase->addr + length > subdev->size)
463 erase->len = subdev->size - erase->addr;
464 else
465 erase->len = length;
466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 length -= erase->len;
468 if ((err = concat_dev_erase(subdev, erase))) {
469 /* sanity check: should never happen since
470 * block alignment has been checked above */
Eric Sesterhenn373ebfb2006-03-26 18:15:12 +0200471 BUG_ON(err == -EINVAL);
Adrian Hunterbb0eb212008-08-12 12:40:50 +0300472 if (erase->fail_addr != MTD_FAIL_ADDR_UNKNOWN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 instr->fail_addr = erase->fail_addr + offset;
474 break;
475 }
476 /*
477 * erase->addr specifies the offset of the area to be
478 * erased *within the current subdevice*. It can be
479 * non-zero only the first time through this loop, i.e.
480 * for the first subdevice where blocks need to be erased.
481 * All the following erases must begin at the start of the
482 * current subdevice, i.e. at offset zero.
483 */
484 erase->addr = 0;
485 offset += subdev->size;
486 }
487 instr->state = erase->state;
488 kfree(erase);
489 if (err)
490 return err;
491
492 if (instr->callback)
493 instr->callback(instr);
494 return 0;
495}
496
Adrian Hunter69423d92008-12-10 13:37:21 +0000497static int concat_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498{
499 struct mtd_concat *concat = CONCAT(mtd);
500 int i, err = -EINVAL;
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 for (i = 0; i < concat->num_subdev; i++) {
503 struct mtd_info *subdev = concat->subdev[i];
Adrian Hunter69423d92008-12-10 13:37:21 +0000504 uint64_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506 if (ofs >= subdev->size) {
507 size = 0;
508 ofs -= subdev->size;
509 continue;
510 }
511 if (ofs + len > subdev->size)
512 size = subdev->size - ofs;
513 else
514 size = len;
515
Artem Bityutskiy38134562011-12-30 17:00:35 +0200516 err = mtd_lock(subdev, ofs, size);
517 if (err)
518 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520 len -= size;
521 if (len == 0)
522 break;
523
524 err = -EINVAL;
525 ofs = 0;
526 }
527
528 return err;
529}
530
Adrian Hunter69423d92008-12-10 13:37:21 +0000531static int concat_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
533 struct mtd_concat *concat = CONCAT(mtd);
534 int i, err = 0;
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 for (i = 0; i < concat->num_subdev; i++) {
537 struct mtd_info *subdev = concat->subdev[i];
Adrian Hunter69423d92008-12-10 13:37:21 +0000538 uint64_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 if (ofs >= subdev->size) {
541 size = 0;
542 ofs -= subdev->size;
543 continue;
544 }
545 if (ofs + len > subdev->size)
546 size = subdev->size - ofs;
547 else
548 size = len;
549
Artem Bityutskiy38134562011-12-30 17:00:35 +0200550 err = mtd_unlock(subdev, ofs, size);
551 if (err)
552 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
554 len -= size;
555 if (len == 0)
556 break;
557
558 err = -EINVAL;
559 ofs = 0;
560 }
561
562 return err;
563}
564
565static void concat_sync(struct mtd_info *mtd)
566{
567 struct mtd_concat *concat = CONCAT(mtd);
568 int i;
569
570 for (i = 0; i < concat->num_subdev; i++) {
571 struct mtd_info *subdev = concat->subdev[i];
Artem Bityutskiy85f2f2a2011-12-23 19:03:12 +0200572 mtd_sync(subdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
574}
575
576static int concat_suspend(struct mtd_info *mtd)
577{
578 struct mtd_concat *concat = CONCAT(mtd);
579 int i, rc = 0;
580
581 for (i = 0; i < concat->num_subdev; i++) {
582 struct mtd_info *subdev = concat->subdev[i];
Artem Bityutskiy3fe4bae2011-12-23 19:25:16 +0200583 if ((rc = mtd_suspend(subdev)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return rc;
585 }
586 return rc;
587}
588
589static void concat_resume(struct mtd_info *mtd)
590{
591 struct mtd_concat *concat = CONCAT(mtd);
592 int i;
593
594 for (i = 0; i < concat->num_subdev; i++) {
595 struct mtd_info *subdev = concat->subdev[i];
Artem Bityutskiyead995f2011-12-23 19:31:25 +0200596 mtd_resume(subdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
598}
599
Alexander Belyakove8d32932006-05-17 19:11:16 +0400600static int concat_block_isbad(struct mtd_info *mtd, loff_t ofs)
601{
602 struct mtd_concat *concat = CONCAT(mtd);
603 int i, res = 0;
604
Artem Bityutskiy8f461a72012-01-02 13:48:54 +0200605 if (!mtd_can_have_bb(concat->subdev[0]))
Alexander Belyakove8d32932006-05-17 19:11:16 +0400606 return res;
607
Alexander Belyakove8d32932006-05-17 19:11:16 +0400608 for (i = 0; i < concat->num_subdev; i++) {
609 struct mtd_info *subdev = concat->subdev[i];
610
611 if (ofs >= subdev->size) {
612 ofs -= subdev->size;
613 continue;
614 }
615
Artem Bityutskiy7086c192011-12-23 19:35:30 +0200616 res = mtd_block_isbad(subdev, ofs);
Alexander Belyakove8d32932006-05-17 19:11:16 +0400617 break;
618 }
619
620 return res;
621}
622
623static int concat_block_markbad(struct mtd_info *mtd, loff_t ofs)
624{
625 struct mtd_concat *concat = CONCAT(mtd);
626 int i, err = -EINVAL;
627
Alexander Belyakove8d32932006-05-17 19:11:16 +0400628 for (i = 0; i < concat->num_subdev; i++) {
629 struct mtd_info *subdev = concat->subdev[i];
630
631 if (ofs >= subdev->size) {
632 ofs -= subdev->size;
633 continue;
634 }
635
Artem Bityutskiy5942ddb2011-12-23 19:37:38 +0200636 err = mtd_block_markbad(subdev, ofs);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200637 if (!err)
638 mtd->ecc_stats.badblocks++;
Alexander Belyakove8d32932006-05-17 19:11:16 +0400639 break;
640 }
641
642 return err;
643}
644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645/*
David Howells6e232cf2009-02-12 10:40:05 +0000646 * try to support NOMMU mmaps on concatenated devices
647 * - we don't support subdev spanning as we can't guarantee it'll work
648 */
649static unsigned long concat_get_unmapped_area(struct mtd_info *mtd,
650 unsigned long len,
651 unsigned long offset,
652 unsigned long flags)
653{
654 struct mtd_concat *concat = CONCAT(mtd);
655 int i;
656
657 for (i = 0; i < concat->num_subdev; i++) {
658 struct mtd_info *subdev = concat->subdev[i];
659
660 if (offset >= subdev->size) {
661 offset -= subdev->size;
662 continue;
663 }
664
Artem Bityutskiycd621272011-12-30 14:31:57 +0200665 return mtd_get_unmapped_area(subdev, len, offset, flags);
David Howells6e232cf2009-02-12 10:40:05 +0000666 }
667
668 return (unsigned long) -ENOSYS;
669}
670
671/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 * This function constructs a virtual MTD device by concatenating
673 * num_devs MTD devices. A pointer to the new device object is
674 * stored to *new_dev upon success. This function does _not_
675 * register any devices: this is the caller's responsibility.
676 */
677struct mtd_info *mtd_concat_create(struct mtd_info *subdev[], /* subdevices to concatenate */
678 int num_devs, /* number of subdevices */
Kay Sievers160bbab2008-12-23 10:00:14 +0000679 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{ /* name for the new device */
681 int i;
682 size_t size;
683 struct mtd_concat *concat;
David Woodhouse26cdb672008-12-10 14:08:12 +0000684 uint32_t max_erasesize, curr_erasesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 int num_erase_region;
Holger Brunck771df612011-01-24 17:45:42 +0100686 int max_writebufsize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 printk(KERN_NOTICE "Concatenating MTD devices:\n");
689 for (i = 0; i < num_devs; i++)
690 printk(KERN_NOTICE "(%d): \"%s\"\n", i, subdev[i]->name);
691 printk(KERN_NOTICE "into device \"%s\"\n", name);
692
693 /* allocate the device structure */
694 size = SIZEOF_STRUCT_MTD_CONCAT(num_devs);
Burman Yan95b93a02006-11-15 21:10:29 +0200695 concat = kzalloc(size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 if (!concat) {
697 printk
698 ("memory allocation error while creating concatenated device \"%s\"\n",
699 name);
700 return NULL;
701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 concat->subdev = (struct mtd_info **) (concat + 1);
703
704 /*
705 * Set up the new "super" device's MTD object structure, check for
Brian Norris92394b5c2011-07-20 09:53:42 -0700706 * incompatibilities between the subdevices.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 */
708 concat->mtd.type = subdev[0]->type;
709 concat->mtd.flags = subdev[0]->flags;
710 concat->mtd.size = subdev[0]->size;
711 concat->mtd.erasesize = subdev[0]->erasesize;
Joern Engel28318772006-05-22 23:18:05 +0200712 concat->mtd.writesize = subdev[0]->writesize;
Holger Brunck771df612011-01-24 17:45:42 +0100713
714 for (i = 0; i < num_devs; i++)
715 if (max_writebufsize < subdev[i]->writebufsize)
716 max_writebufsize = subdev[i]->writebufsize;
717 concat->mtd.writebufsize = max_writebufsize;
718
Chris Paulson-Ellisa2e1b832007-10-12 10:54:06 +0100719 concat->mtd.subpage_sft = subdev[0]->subpage_sft;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 concat->mtd.oobsize = subdev[0]->oobsize;
Vitaly Wool1f922672007-03-06 16:56:34 +0300721 concat->mtd.oobavail = subdev[0]->oobavail;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200722 if (subdev[0]->_writev)
723 concat->mtd._writev = concat_writev;
724 if (subdev[0]->_read_oob)
725 concat->mtd._read_oob = concat_read_oob;
726 if (subdev[0]->_write_oob)
727 concat->mtd._write_oob = concat_write_oob;
728 if (subdev[0]->_block_isbad)
729 concat->mtd._block_isbad = concat_block_isbad;
730 if (subdev[0]->_block_markbad)
731 concat->mtd._block_markbad = concat_block_markbad;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200733 concat->mtd.ecc_stats.badblocks = subdev[0]->ecc_stats.badblocks;
734
David Howells6e232cf2009-02-12 10:40:05 +0000735 concat->mtd.backing_dev_info = subdev[0]->backing_dev_info;
736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 concat->subdev[0] = subdev[0];
738
739 for (i = 1; i < num_devs; i++) {
740 if (concat->mtd.type != subdev[i]->type) {
741 kfree(concat);
742 printk("Incompatible device type on \"%s\"\n",
743 subdev[i]->name);
744 return NULL;
745 }
746 if (concat->mtd.flags != subdev[i]->flags) {
747 /*
748 * Expect all flags except MTD_WRITEABLE to be
749 * equal on all subdevices.
750 */
751 if ((concat->mtd.flags ^ subdev[i]->
752 flags) & ~MTD_WRITEABLE) {
753 kfree(concat);
754 printk("Incompatible device flags on \"%s\"\n",
755 subdev[i]->name);
756 return NULL;
757 } else
758 /* if writeable attribute differs,
759 make super device writeable */
760 concat->mtd.flags |=
761 subdev[i]->flags & MTD_WRITEABLE;
762 }
David Howells6e232cf2009-02-12 10:40:05 +0000763
764 /* only permit direct mapping if the BDIs are all the same
765 * - copy-mapping is still permitted
766 */
767 if (concat->mtd.backing_dev_info !=
768 subdev[i]->backing_dev_info)
769 concat->mtd.backing_dev_info =
770 &default_backing_dev_info;
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 concat->mtd.size += subdev[i]->size;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200773 concat->mtd.ecc_stats.badblocks +=
774 subdev[i]->ecc_stats.badblocks;
Joern Engel28318772006-05-22 23:18:05 +0200775 if (concat->mtd.writesize != subdev[i]->writesize ||
Thomas Gleixner29072b92006-09-28 15:38:36 +0200776 concat->mtd.subpage_sft != subdev[i]->subpage_sft ||
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 concat->mtd.oobsize != subdev[i]->oobsize ||
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200778 !concat->mtd._read_oob != !subdev[i]->_read_oob ||
779 !concat->mtd._write_oob != !subdev[i]->_write_oob) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 kfree(concat);
781 printk("Incompatible OOB or ECC data on \"%s\"\n",
782 subdev[i]->name);
783 return NULL;
784 }
785 concat->subdev[i] = subdev[i];
786
787 }
788
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200789 concat->mtd.ecclayout = subdev[0]->ecclayout;
Alexander Belyakove8d32932006-05-17 19:11:16 +0400790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 concat->num_subdev = num_devs;
792 concat->mtd.name = name;
793
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200794 concat->mtd._erase = concat_erase;
795 concat->mtd._read = concat_read;
796 concat->mtd._write = concat_write;
797 concat->mtd._sync = concat_sync;
798 concat->mtd._lock = concat_lock;
799 concat->mtd._unlock = concat_unlock;
800 concat->mtd._suspend = concat_suspend;
801 concat->mtd._resume = concat_resume;
802 concat->mtd._get_unmapped_area = concat_get_unmapped_area;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
804 /*
805 * Combine the erase block size info of the subdevices:
806 *
807 * first, walk the map of the new device and see how
808 * many changes in erase size we have
809 */
810 max_erasesize = curr_erasesize = subdev[0]->erasesize;
811 num_erase_region = 1;
812 for (i = 0; i < num_devs; i++) {
813 if (subdev[i]->numeraseregions == 0) {
814 /* current subdevice has uniform erase size */
815 if (subdev[i]->erasesize != curr_erasesize) {
816 /* if it differs from the last subdevice's erase size, count it */
817 ++num_erase_region;
818 curr_erasesize = subdev[i]->erasesize;
819 if (curr_erasesize > max_erasesize)
820 max_erasesize = curr_erasesize;
821 }
822 } else {
823 /* current subdevice has variable erase size */
824 int j;
825 for (j = 0; j < subdev[i]->numeraseregions; j++) {
826
827 /* walk the list of erase regions, count any changes */
828 if (subdev[i]->eraseregions[j].erasesize !=
829 curr_erasesize) {
830 ++num_erase_region;
831 curr_erasesize =
832 subdev[i]->eraseregions[j].
833 erasesize;
834 if (curr_erasesize > max_erasesize)
835 max_erasesize = curr_erasesize;
836 }
837 }
838 }
839 }
840
841 if (num_erase_region == 1) {
842 /*
843 * All subdevices have the same uniform erase size.
844 * This is easy:
845 */
846 concat->mtd.erasesize = curr_erasesize;
847 concat->mtd.numeraseregions = 0;
848 } else {
Adrian Hunter69423d92008-12-10 13:37:21 +0000849 uint64_t tmp64;
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 /*
852 * erase block size varies across the subdevices: allocate
853 * space to store the data describing the variable erase regions
854 */
855 struct mtd_erase_region_info *erase_region_p;
Adrian Hunter69423d92008-12-10 13:37:21 +0000856 uint64_t begin, position;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
858 concat->mtd.erasesize = max_erasesize;
859 concat->mtd.numeraseregions = num_erase_region;
860 concat->mtd.eraseregions = erase_region_p =
861 kmalloc(num_erase_region *
862 sizeof (struct mtd_erase_region_info), GFP_KERNEL);
863 if (!erase_region_p) {
864 kfree(concat);
865 printk
866 ("memory allocation error while creating erase region list"
867 " for device \"%s\"\n", name);
868 return NULL;
869 }
870
871 /*
872 * walk the map of the new device once more and fill in
873 * in erase region info:
874 */
875 curr_erasesize = subdev[0]->erasesize;
876 begin = position = 0;
877 for (i = 0; i < num_devs; i++) {
878 if (subdev[i]->numeraseregions == 0) {
879 /* current subdevice has uniform erase size */
880 if (subdev[i]->erasesize != curr_erasesize) {
881 /*
882 * fill in an mtd_erase_region_info structure for the area
883 * we have walked so far:
884 */
885 erase_region_p->offset = begin;
886 erase_region_p->erasesize =
887 curr_erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000888 tmp64 = position - begin;
889 do_div(tmp64, curr_erasesize);
890 erase_region_p->numblocks = tmp64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 begin = position;
892
893 curr_erasesize = subdev[i]->erasesize;
894 ++erase_region_p;
895 }
896 position += subdev[i]->size;
897 } else {
898 /* current subdevice has variable erase size */
899 int j;
900 for (j = 0; j < subdev[i]->numeraseregions; j++) {
901 /* walk the list of erase regions, count any changes */
902 if (subdev[i]->eraseregions[j].
903 erasesize != curr_erasesize) {
904 erase_region_p->offset = begin;
905 erase_region_p->erasesize =
906 curr_erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000907 tmp64 = position - begin;
908 do_div(tmp64, curr_erasesize);
909 erase_region_p->numblocks = tmp64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 begin = position;
911
912 curr_erasesize =
913 subdev[i]->eraseregions[j].
914 erasesize;
915 ++erase_region_p;
916 }
917 position +=
918 subdev[i]->eraseregions[j].
Adrian Hunter69423d92008-12-10 13:37:21 +0000919 numblocks * (uint64_t)curr_erasesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 }
921 }
922 }
923 /* Now write the final entry */
924 erase_region_p->offset = begin;
925 erase_region_p->erasesize = curr_erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000926 tmp64 = position - begin;
927 do_div(tmp64, curr_erasesize);
928 erase_region_p->numblocks = tmp64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 }
930
931 return &concat->mtd;
932}
933
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000934/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 * This function destroys an MTD object obtained from concat_mtd_devs()
936 */
937
938void mtd_concat_destroy(struct mtd_info *mtd)
939{
940 struct mtd_concat *concat = CONCAT(mtd);
941 if (concat->mtd.numeraseregions)
942 kfree(concat->mtd.eraseregions);
943 kfree(concat);
944}
945
946EXPORT_SYMBOL(mtd_concat_create);
947EXPORT_SYMBOL(mtd_concat_destroy);
948
949MODULE_LICENSE("GPL");
950MODULE_AUTHOR("Robert Kaiser <rkaiser@sysgo.de>");
951MODULE_DESCRIPTION("Generic support for concatenating of MTD devices");