2 * MTD device concatenation layer
4 * (C) 2002 Robert Kaiser <rkaiser@sysgo.de>
6 * NAND support by Christian Gan <cgan@iders.ca>
10 * $Id: mtdconcat.c,v 1.9 2004/06/30 15:17:41 dbrown Exp $
13 #include <linux/module.h>
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/mtd/concat.h>
22 * Our storage structure:
23 * Subdev points to an array of pointers to struct mtd_info objects
24 * which is allocated along with this structure
30 struct mtd_info
**subdev
;
34 * how to calculate the size required for the above structure,
35 * including the pointer array subdev points to:
37 #define SIZEOF_STRUCT_MTD_CONCAT(num_subdev) \
38 ((sizeof(struct mtd_concat) + (num_subdev) * sizeof(struct mtd_info *)))
41 * Given a pointer to the MTD object in the mtd_concat structure,
42 * we can retrieve the pointer to that structure with this macro.
44 #define CONCAT(x) ((struct mtd_concat *)(x))
47 * MTD methods which look up the relevant subdevice, translate the
48 * effective address and pass through to the subdevice.
52 concat_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
53 size_t * retlen
, u_char
* buf
)
55 struct mtd_concat
*concat
= CONCAT(mtd
);
61 for (i
= 0; i
< concat
->num_subdev
; i
++) {
62 struct mtd_info
*subdev
= concat
->subdev
[i
];
65 if (from
>= subdev
->size
) {
66 /* Not destined for this subdev */
71 if (from
+ len
> subdev
->size
)
72 /* First part goes into this subdev */
73 size
= subdev
->size
- from
;
75 /* Entire transaction goes into this subdev */
78 err
= subdev
->read(subdev
, from
, size
, &retsize
, buf
);
96 concat_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
97 size_t * retlen
, const u_char
* buf
)
99 struct mtd_concat
*concat
= CONCAT(mtd
);
103 if (!(mtd
->flags
& MTD_WRITEABLE
))
108 for (i
= 0; i
< concat
->num_subdev
; i
++) {
109 struct mtd_info
*subdev
= concat
->subdev
[i
];
110 size_t size
, retsize
;
112 if (to
>= subdev
->size
) {
117 if (to
+ len
> subdev
->size
)
118 size
= subdev
->size
- to
;
122 if (!(subdev
->flags
& MTD_WRITEABLE
))
125 err
= subdev
->write(subdev
, to
, size
, &retsize
, buf
);
143 concat_read_ecc(struct mtd_info
*mtd
, loff_t from
, size_t len
,
144 size_t * retlen
, u_char
* buf
, u_char
* eccbuf
,
145 struct nand_oobinfo
*oobsel
)
147 struct mtd_concat
*concat
= CONCAT(mtd
);
153 for (i
= 0; i
< concat
->num_subdev
; i
++) {
154 struct mtd_info
*subdev
= concat
->subdev
[i
];
155 size_t size
, retsize
;
157 if (from
>= subdev
->size
) {
158 /* Not destined for this subdev */
160 from
-= subdev
->size
;
164 if (from
+ len
> subdev
->size
)
165 /* First part goes into this subdev */
166 size
= subdev
->size
- from
;
168 /* Entire transaction goes into this subdev */
171 if (subdev
->read_ecc
)
172 err
= subdev
->read_ecc(subdev
, from
, size
,
173 &retsize
, buf
, eccbuf
, oobsel
);
188 eccbuf
+= subdev
->oobsize
;
189 /* in nand.c at least, eccbufs are
190 tagged with 2 (int)eccstatus'; we
191 must account for these */
192 eccbuf
+= 2 * (sizeof (int));
200 concat_write_ecc(struct mtd_info
*mtd
, loff_t to
, size_t len
,
201 size_t * retlen
, const u_char
* buf
, u_char
* eccbuf
,
202 struct nand_oobinfo
*oobsel
)
204 struct mtd_concat
*concat
= CONCAT(mtd
);
208 if (!(mtd
->flags
& MTD_WRITEABLE
))
213 for (i
= 0; i
< concat
->num_subdev
; i
++) {
214 struct mtd_info
*subdev
= concat
->subdev
[i
];
215 size_t size
, retsize
;
217 if (to
>= subdev
->size
) {
222 if (to
+ len
> subdev
->size
)
223 size
= subdev
->size
- to
;
227 if (!(subdev
->flags
& MTD_WRITEABLE
))
229 else if (subdev
->write_ecc
)
230 err
= subdev
->write_ecc(subdev
, to
, size
,
231 &retsize
, buf
, eccbuf
, oobsel
);
246 eccbuf
+= subdev
->oobsize
;
253 concat_read_oob(struct mtd_info
*mtd
, loff_t from
, size_t len
,
254 size_t * retlen
, u_char
* buf
)
256 struct mtd_concat
*concat
= CONCAT(mtd
);
262 for (i
= 0; i
< concat
->num_subdev
; i
++) {
263 struct mtd_info
*subdev
= concat
->subdev
[i
];
264 size_t size
, retsize
;
266 if (from
>= subdev
->size
) {
267 /* Not destined for this subdev */
269 from
-= subdev
->size
;
272 if (from
+ len
> subdev
->size
)
273 /* First part goes into this subdev */
274 size
= subdev
->size
- from
;
276 /* Entire transaction goes into this subdev */
279 if (subdev
->read_oob
)
280 err
= subdev
->read_oob(subdev
, from
, size
,
301 concat_write_oob(struct mtd_info
*mtd
, loff_t to
, size_t len
,
302 size_t * retlen
, const u_char
* buf
)
304 struct mtd_concat
*concat
= CONCAT(mtd
);
308 if (!(mtd
->flags
& MTD_WRITEABLE
))
313 for (i
= 0; i
< concat
->num_subdev
; i
++) {
314 struct mtd_info
*subdev
= concat
->subdev
[i
];
315 size_t size
, retsize
;
317 if (to
>= subdev
->size
) {
322 if (to
+ len
> subdev
->size
)
323 size
= subdev
->size
- to
;
327 if (!(subdev
->flags
& MTD_WRITEABLE
))
329 else if (subdev
->write_oob
)
330 err
= subdev
->write_oob(subdev
, to
, size
, &retsize
,
350 static void concat_erase_callback(struct erase_info
*instr
)
352 wake_up((wait_queue_head_t
*) instr
->priv
);
355 static int concat_dev_erase(struct mtd_info
*mtd
, struct erase_info
*erase
)
358 wait_queue_head_t waitq
;
359 DECLARE_WAITQUEUE(wait
, current
);
362 * This code was stol^H^H^H^Hinspired by mtdchar.c
364 init_waitqueue_head(&waitq
);
367 erase
->callback
= concat_erase_callback
;
368 erase
->priv
= (unsigned long) &waitq
;
371 * FIXME: Allow INTERRUPTIBLE. Which means
372 * not having the wait_queue head on the stack.
374 err
= mtd
->erase(mtd
, erase
);
376 set_current_state(TASK_UNINTERRUPTIBLE
);
377 add_wait_queue(&waitq
, &wait
);
378 if (erase
->state
!= MTD_ERASE_DONE
379 && erase
->state
!= MTD_ERASE_FAILED
)
381 remove_wait_queue(&waitq
, &wait
);
382 set_current_state(TASK_RUNNING
);
384 err
= (erase
->state
== MTD_ERASE_FAILED
) ? -EIO
: 0;
389 static int concat_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
391 struct mtd_concat
*concat
= CONCAT(mtd
);
392 struct mtd_info
*subdev
;
394 u_int32_t length
, offset
= 0;
395 struct erase_info
*erase
;
397 if (!(mtd
->flags
& MTD_WRITEABLE
))
400 if (instr
->addr
> concat
->mtd
.size
)
403 if (instr
->len
+ instr
->addr
> concat
->mtd
.size
)
407 * Check for proper erase block alignment of the to-be-erased area.
408 * It is easier to do this based on the super device's erase
409 * region info rather than looking at each particular sub-device
412 if (!concat
->mtd
.numeraseregions
) {
413 /* the easy case: device has uniform erase block size */
414 if (instr
->addr
& (concat
->mtd
.erasesize
- 1))
416 if (instr
->len
& (concat
->mtd
.erasesize
- 1))
419 /* device has variable erase size */
420 struct mtd_erase_region_info
*erase_regions
=
421 concat
->mtd
.eraseregions
;
424 * Find the erase region where the to-be-erased area begins:
426 for (i
= 0; i
< concat
->mtd
.numeraseregions
&&
427 instr
->addr
>= erase_regions
[i
].offset
; i
++) ;
431 * Now erase_regions[i] is the region in which the
432 * to-be-erased area begins. Verify that the starting
433 * offset is aligned to this region's erase size:
435 if (instr
->addr
& (erase_regions
[i
].erasesize
- 1))
439 * now find the erase region where the to-be-erased area ends:
441 for (; i
< concat
->mtd
.numeraseregions
&&
442 (instr
->addr
+ instr
->len
) >= erase_regions
[i
].offset
;
446 * check if the ending offset is aligned to this region's erase size
448 if ((instr
->addr
+ instr
->len
) & (erase_regions
[i
].erasesize
-
453 instr
->fail_addr
= 0xffffffff;
455 /* make a local copy of instr to avoid modifying the caller's struct */
456 erase
= kmalloc(sizeof (struct erase_info
), GFP_KERNEL
);
465 * find the subdevice where the to-be-erased area begins, adjust
466 * starting offset to be relative to the subdevice start
468 for (i
= 0; i
< concat
->num_subdev
; i
++) {
469 subdev
= concat
->subdev
[i
];
470 if (subdev
->size
<= erase
->addr
) {
471 erase
->addr
-= subdev
->size
;
472 offset
+= subdev
->size
;
478 /* must never happen since size limit has been verified above */
479 if (i
>= concat
->num_subdev
)
482 /* now do the erase: */
484 for (; length
> 0; i
++) {
485 /* loop for all subdevices affected by this request */
486 subdev
= concat
->subdev
[i
]; /* get current subdevice */
488 /* limit length to subdevice's size: */
489 if (erase
->addr
+ length
> subdev
->size
)
490 erase
->len
= subdev
->size
- erase
->addr
;
494 if (!(subdev
->flags
& MTD_WRITEABLE
)) {
498 length
-= erase
->len
;
499 if ((err
= concat_dev_erase(subdev
, erase
))) {
500 /* sanity check: should never happen since
501 * block alignment has been checked above */
504 if (erase
->fail_addr
!= 0xffffffff)
505 instr
->fail_addr
= erase
->fail_addr
+ offset
;
509 * erase->addr specifies the offset of the area to be
510 * erased *within the current subdevice*. It can be
511 * non-zero only the first time through this loop, i.e.
512 * for the first subdevice where blocks need to be erased.
513 * All the following erases must begin at the start of the
514 * current subdevice, i.e. at offset zero.
517 offset
+= subdev
->size
;
519 instr
->state
= erase
->state
;
525 instr
->callback(instr
);
529 static int concat_lock(struct mtd_info
*mtd
, loff_t ofs
, size_t len
)
531 struct mtd_concat
*concat
= CONCAT(mtd
);
532 int i
, err
= -EINVAL
;
534 if ((len
+ ofs
) > mtd
->size
)
537 for (i
= 0; i
< concat
->num_subdev
; i
++) {
538 struct mtd_info
*subdev
= concat
->subdev
[i
];
541 if (ofs
>= subdev
->size
) {
546 if (ofs
+ len
> subdev
->size
)
547 size
= subdev
->size
- ofs
;
551 err
= subdev
->lock(subdev
, ofs
, size
);
567 static int concat_unlock(struct mtd_info
*mtd
, loff_t ofs
, size_t len
)
569 struct mtd_concat
*concat
= CONCAT(mtd
);
572 if ((len
+ ofs
) > mtd
->size
)
575 for (i
= 0; i
< concat
->num_subdev
; i
++) {
576 struct mtd_info
*subdev
= concat
->subdev
[i
];
579 if (ofs
>= subdev
->size
) {
584 if (ofs
+ len
> subdev
->size
)
585 size
= subdev
->size
- ofs
;
589 err
= subdev
->unlock(subdev
, ofs
, size
);
605 static void concat_sync(struct mtd_info
*mtd
)
607 struct mtd_concat
*concat
= CONCAT(mtd
);
610 for (i
= 0; i
< concat
->num_subdev
; i
++) {
611 struct mtd_info
*subdev
= concat
->subdev
[i
];
612 subdev
->sync(subdev
);
616 static int concat_suspend(struct mtd_info
*mtd
)
618 struct mtd_concat
*concat
= CONCAT(mtd
);
621 for (i
= 0; i
< concat
->num_subdev
; i
++) {
622 struct mtd_info
*subdev
= concat
->subdev
[i
];
623 if ((rc
= subdev
->suspend(subdev
)) < 0)
629 static void concat_resume(struct mtd_info
*mtd
)
631 struct mtd_concat
*concat
= CONCAT(mtd
);
634 for (i
= 0; i
< concat
->num_subdev
; i
++) {
635 struct mtd_info
*subdev
= concat
->subdev
[i
];
636 subdev
->resume(subdev
);
641 * This function constructs a virtual MTD device by concatenating
642 * num_devs MTD devices. A pointer to the new device object is
643 * stored to *new_dev upon success. This function does _not_
644 * register any devices: this is the caller's responsibility.
646 struct mtd_info
*mtd_concat_create(struct mtd_info
*subdev
[], /* subdevices to concatenate */
647 int num_devs
, /* number of subdevices */
649 { /* name for the new device */
652 struct mtd_concat
*concat
;
653 u_int32_t max_erasesize
, curr_erasesize
;
654 int num_erase_region
;
656 printk(KERN_NOTICE
"Concatenating MTD devices:\n");
657 for (i
= 0; i
< num_devs
; i
++)
658 printk(KERN_NOTICE
"(%d): \"%s\"\n", i
, subdev
[i
]->name
);
659 printk(KERN_NOTICE
"into device \"%s\"\n", name
);
661 /* allocate the device structure */
662 size
= SIZEOF_STRUCT_MTD_CONCAT(num_devs
);
663 concat
= kmalloc(size
, GFP_KERNEL
);
666 ("memory allocation error while creating concatenated device \"%s\"\n",
670 memset(concat
, 0, size
);
671 concat
->subdev
= (struct mtd_info
**) (concat
+ 1);
674 * Set up the new "super" device's MTD object structure, check for
675 * incompatibilites between the subdevices.
677 concat
->mtd
.type
= subdev
[0]->type
;
678 concat
->mtd
.flags
= subdev
[0]->flags
;
679 concat
->mtd
.size
= subdev
[0]->size
;
680 concat
->mtd
.erasesize
= subdev
[0]->erasesize
;
681 concat
->mtd
.oobblock
= subdev
[0]->oobblock
;
682 concat
->mtd
.oobsize
= subdev
[0]->oobsize
;
683 concat
->mtd
.ecctype
= subdev
[0]->ecctype
;
684 concat
->mtd
.eccsize
= subdev
[0]->eccsize
;
685 if (subdev
[0]->read_ecc
)
686 concat
->mtd
.read_ecc
= concat_read_ecc
;
687 if (subdev
[0]->write_ecc
)
688 concat
->mtd
.write_ecc
= concat_write_ecc
;
689 if (subdev
[0]->read_oob
)
690 concat
->mtd
.read_oob
= concat_read_oob
;
691 if (subdev
[0]->write_oob
)
692 concat
->mtd
.write_oob
= concat_write_oob
;
694 concat
->subdev
[0] = subdev
[0];
696 for (i
= 1; i
< num_devs
; i
++) {
697 if (concat
->mtd
.type
!= subdev
[i
]->type
) {
699 printk("Incompatible device type on \"%s\"\n",
703 if (concat
->mtd
.flags
!= subdev
[i
]->flags
) {
705 * Expect all flags except MTD_WRITEABLE to be
706 * equal on all subdevices.
708 if ((concat
->mtd
.flags
^ subdev
[i
]->
709 flags
) & ~MTD_WRITEABLE
) {
711 printk("Incompatible device flags on \"%s\"\n",
715 /* if writeable attribute differs,
716 make super device writeable */
718 subdev
[i
]->flags
& MTD_WRITEABLE
;
720 concat
->mtd
.size
+= subdev
[i
]->size
;
721 if (concat
->mtd
.oobblock
!= subdev
[i
]->oobblock
||
722 concat
->mtd
.oobsize
!= subdev
[i
]->oobsize
||
723 concat
->mtd
.ecctype
!= subdev
[i
]->ecctype
||
724 concat
->mtd
.eccsize
!= subdev
[i
]->eccsize
||
725 !concat
->mtd
.read_ecc
!= !subdev
[i
]->read_ecc
||
726 !concat
->mtd
.write_ecc
!= !subdev
[i
]->write_ecc
||
727 !concat
->mtd
.read_oob
!= !subdev
[i
]->read_oob
||
728 !concat
->mtd
.write_oob
!= !subdev
[i
]->write_oob
) {
730 printk("Incompatible OOB or ECC data on \"%s\"\n",
734 concat
->subdev
[i
] = subdev
[i
];
738 concat
->num_subdev
= num_devs
;
739 concat
->mtd
.name
= name
;
742 * NOTE: for now, we do not provide any readv()/writev() methods
743 * because they are messy to implement and they are not
744 * used to a great extent anyway.
746 concat
->mtd
.erase
= concat_erase
;
747 concat
->mtd
.read
= concat_read
;
748 concat
->mtd
.write
= concat_write
;
749 concat
->mtd
.sync
= concat_sync
;
750 concat
->mtd
.lock
= concat_lock
;
751 concat
->mtd
.unlock
= concat_unlock
;
752 concat
->mtd
.suspend
= concat_suspend
;
753 concat
->mtd
.resume
= concat_resume
;
756 * Combine the erase block size info of the subdevices:
758 * first, walk the map of the new device and see how
759 * many changes in erase size we have
761 max_erasesize
= curr_erasesize
= subdev
[0]->erasesize
;
762 num_erase_region
= 1;
763 for (i
= 0; i
< num_devs
; i
++) {
764 if (subdev
[i
]->numeraseregions
== 0) {
765 /* current subdevice has uniform erase size */
766 if (subdev
[i
]->erasesize
!= curr_erasesize
) {
767 /* if it differs from the last subdevice's erase size, count it */
769 curr_erasesize
= subdev
[i
]->erasesize
;
770 if (curr_erasesize
> max_erasesize
)
771 max_erasesize
= curr_erasesize
;
774 /* current subdevice has variable erase size */
776 for (j
= 0; j
< subdev
[i
]->numeraseregions
; j
++) {
778 /* walk the list of erase regions, count any changes */
779 if (subdev
[i
]->eraseregions
[j
].erasesize
!=
783 subdev
[i
]->eraseregions
[j
].
785 if (curr_erasesize
> max_erasesize
)
786 max_erasesize
= curr_erasesize
;
792 if (num_erase_region
== 1) {
794 * All subdevices have the same uniform erase size.
797 concat
->mtd
.erasesize
= curr_erasesize
;
798 concat
->mtd
.numeraseregions
= 0;
801 * erase block size varies across the subdevices: allocate
802 * space to store the data describing the variable erase regions
804 struct mtd_erase_region_info
*erase_region_p
;
805 u_int32_t begin
, position
;
807 concat
->mtd
.erasesize
= max_erasesize
;
808 concat
->mtd
.numeraseregions
= num_erase_region
;
809 concat
->mtd
.eraseregions
= erase_region_p
=
810 kmalloc(num_erase_region
*
811 sizeof (struct mtd_erase_region_info
), GFP_KERNEL
);
812 if (!erase_region_p
) {
815 ("memory allocation error while creating erase region list"
816 " for device \"%s\"\n", name
);
821 * walk the map of the new device once more and fill in
822 * in erase region info:
824 curr_erasesize
= subdev
[0]->erasesize
;
825 begin
= position
= 0;
826 for (i
= 0; i
< num_devs
; i
++) {
827 if (subdev
[i
]->numeraseregions
== 0) {
828 /* current subdevice has uniform erase size */
829 if (subdev
[i
]->erasesize
!= curr_erasesize
) {
831 * fill in an mtd_erase_region_info structure for the area
832 * we have walked so far:
834 erase_region_p
->offset
= begin
;
835 erase_region_p
->erasesize
=
837 erase_region_p
->numblocks
=
838 (position
- begin
) / curr_erasesize
;
841 curr_erasesize
= subdev
[i
]->erasesize
;
844 position
+= subdev
[i
]->size
;
846 /* current subdevice has variable erase size */
848 for (j
= 0; j
< subdev
[i
]->numeraseregions
; j
++) {
849 /* walk the list of erase regions, count any changes */
850 if (subdev
[i
]->eraseregions
[j
].
851 erasesize
!= curr_erasesize
) {
852 erase_region_p
->offset
= begin
;
853 erase_region_p
->erasesize
=
855 erase_region_p
->numblocks
=
857 begin
) / curr_erasesize
;
861 subdev
[i
]->eraseregions
[j
].
866 subdev
[i
]->eraseregions
[j
].
867 numblocks
* curr_erasesize
;
871 /* Now write the final entry */
872 erase_region_p
->offset
= begin
;
873 erase_region_p
->erasesize
= curr_erasesize
;
874 erase_region_p
->numblocks
= (position
- begin
) / curr_erasesize
;
881 * This function destroys an MTD object obtained from concat_mtd_devs()
884 void mtd_concat_destroy(struct mtd_info
*mtd
)
886 struct mtd_concat
*concat
= CONCAT(mtd
);
887 if (concat
->mtd
.numeraseregions
)
888 kfree(concat
->mtd
.eraseregions
);
892 EXPORT_SYMBOL(mtd_concat_create
);
893 EXPORT_SYMBOL(mtd_concat_destroy
);
895 MODULE_LICENSE("GPL");
896 MODULE_AUTHOR("Robert Kaiser <rkaiser@sysgo.de>");
897 MODULE_DESCRIPTION("Generic support for concatenating of MTD devices");