2 * rfd_ftl.c -- resident flash disk (flash translation layer)
4 * Copyright © 2005 Sean Young <sean@mess.org>
6 * This type of flash translation layer (FTL) is used by the Embedded BIOS
7 * by General Software. It is known as the Resident Flash Disk (RFD), see:
9 * http://www.gensw.com/pages/prod/bios/rfd.htm
14 #include <linux/hdreg.h>
15 #include <linux/init.h>
16 #include <linux/mtd/blktrans.h>
17 #include <linux/mtd/mtd.h>
18 #include <linux/vmalloc.h>
19 #include <linux/slab.h>
20 #include <linux/jiffies.h>
21 #include <linux/module.h>
23 #include <asm/types.h>
25 static int block_size
= 0;
26 module_param(block_size
, int, 0);
27 MODULE_PARM_DESC(block_size
, "Block size to use by RFD, defaults to erase unit size");
29 #define PREFIX "rfd_ftl: "
31 /* This major has been assigned by device@lanana.org */
33 #define RFD_FTL_MAJOR 256
36 /* Maximum number of partitions in an FTL region */
39 /* An erase unit should start with this value */
40 #define RFD_MAGIC 0x9193
42 /* the second value is 0xffff or 0xffc8; function unknown */
44 /* the third value is always 0xffff, ignored */
46 /* next is an array of mapping for each corresponding sector */
47 #define HEADER_MAP_OFFSET 3
48 #define SECTOR_DELETED 0x0000
49 #define SECTOR_ZERO 0xfffe
50 #define SECTOR_FREE 0xffff
52 #define SECTOR_SIZE 512
54 #define SECTORS_PER_TRACK 63
71 struct mtd_blktrans_dev mbd
;
73 u_int block_size
; /* size of erase unit */
74 u_int total_blocks
; /* number of erase units */
75 u_int header_sectors_per_block
; /* header sectors in erase unit */
76 u_int data_sectors_per_block
; /* data sectors in erase unit */
77 u_int sector_count
; /* sectors in translated disk */
78 u_int header_size
; /* bytes in header sector */
79 int reserved_block
; /* block next up for reclaim */
80 int current_block
; /* block to write to */
81 u16
*header_cache
; /* cached header */
90 static int rfd_ftl_writesect(struct mtd_blktrans_dev
*dev
, u_long sector
, char *buf
);
92 static int build_block_map(struct partition
*part
, int block_no
)
94 struct block
*block
= &part
->blocks
[block_no
];
97 block
->offset
= part
->block_size
* block_no
;
99 if (le16_to_cpu(part
->header_cache
[0]) != RFD_MAGIC
) {
100 block
->state
= BLOCK_UNUSED
;
104 block
->state
= BLOCK_OK
;
106 for (i
=0; i
<part
->data_sectors_per_block
; i
++) {
109 entry
= le16_to_cpu(part
->header_cache
[HEADER_MAP_OFFSET
+ i
]);
111 if (entry
== SECTOR_DELETED
)
114 if (entry
== SECTOR_FREE
) {
115 block
->free_sectors
++;
119 if (entry
== SECTOR_ZERO
)
122 if (entry
>= part
->sector_count
) {
123 printk(KERN_WARNING PREFIX
124 "'%s': unit #%d: entry %d corrupt, "
125 "sector %d out of range\n",
126 part
->mbd
.mtd
->name
, block_no
, i
, entry
);
130 if (part
->sector_map
[entry
] != -1) {
131 printk(KERN_WARNING PREFIX
132 "'%s': more than one entry for sector %d\n",
133 part
->mbd
.mtd
->name
, entry
);
138 part
->sector_map
[entry
] = block
->offset
+
139 (i
+ part
->header_sectors_per_block
) * SECTOR_SIZE
;
141 block
->used_sectors
++;
144 if (block
->free_sectors
== part
->data_sectors_per_block
)
145 part
->reserved_block
= block_no
;
150 static int scan_header(struct partition
*part
)
152 int sectors_per_block
;
157 sectors_per_block
= part
->block_size
/ SECTOR_SIZE
;
158 part
->total_blocks
= (u32
)part
->mbd
.mtd
->size
/ part
->block_size
;
160 if (part
->total_blocks
< 2)
163 /* each erase block has three bytes header, followed by the map */
164 part
->header_sectors_per_block
=
165 ((HEADER_MAP_OFFSET
+ sectors_per_block
) *
166 sizeof(u16
) + SECTOR_SIZE
- 1) / SECTOR_SIZE
;
168 part
->data_sectors_per_block
= sectors_per_block
-
169 part
->header_sectors_per_block
;
171 part
->header_size
= (HEADER_MAP_OFFSET
+
172 part
->data_sectors_per_block
) * sizeof(u16
);
174 part
->cylinders
= (part
->data_sectors_per_block
*
175 (part
->total_blocks
- 1) - 1) / SECTORS_PER_TRACK
;
177 part
->sector_count
= part
->cylinders
* SECTORS_PER_TRACK
;
179 part
->current_block
= -1;
180 part
->reserved_block
= -1;
181 part
->is_reclaiming
= 0;
183 part
->header_cache
= kmalloc(part
->header_size
, GFP_KERNEL
);
184 if (!part
->header_cache
)
187 part
->blocks
= kcalloc(part
->total_blocks
, sizeof(struct block
),
192 part
->sector_map
= vmalloc(part
->sector_count
* sizeof(u_long
));
193 if (!part
->sector_map
) {
194 printk(KERN_ERR PREFIX
"'%s': unable to allocate memory for "
195 "sector map", part
->mbd
.mtd
->name
);
199 for (i
=0; i
<part
->sector_count
; i
++)
200 part
->sector_map
[i
] = -1;
202 for (i
=0, blocks_found
=0; i
<part
->total_blocks
; i
++) {
203 rc
= part
->mbd
.mtd
->read(part
->mbd
.mtd
,
204 i
* part
->block_size
, part
->header_size
,
205 &retlen
, (u_char
*)part
->header_cache
);
207 if (!rc
&& retlen
!= part
->header_size
)
213 if (!build_block_map(part
, i
))
217 if (blocks_found
== 0) {
218 printk(KERN_NOTICE PREFIX
"no RFD magic found in '%s'\n",
219 part
->mbd
.mtd
->name
);
224 if (part
->reserved_block
== -1) {
225 printk(KERN_WARNING PREFIX
"'%s': no empty erase unit found\n",
226 part
->mbd
.mtd
->name
);
234 vfree(part
->sector_map
);
235 kfree(part
->header_cache
);
241 static int rfd_ftl_readsect(struct mtd_blktrans_dev
*dev
, u_long sector
, char *buf
)
243 struct partition
*part
= (struct partition
*)dev
;
248 if (sector
>= part
->sector_count
)
251 addr
= part
->sector_map
[sector
];
253 rc
= part
->mbd
.mtd
->read(part
->mbd
.mtd
, addr
, SECTOR_SIZE
,
254 &retlen
, (u_char
*)buf
);
255 if (!rc
&& retlen
!= SECTOR_SIZE
)
259 printk(KERN_WARNING PREFIX
"error reading '%s' at "
260 "0x%lx\n", part
->mbd
.mtd
->name
, addr
);
264 memset(buf
, 0, SECTOR_SIZE
);
269 static void erase_callback(struct erase_info
*erase
)
271 struct partition
*part
;
276 part
= (struct partition
*)erase
->priv
;
278 i
= (u32
)erase
->addr
/ part
->block_size
;
279 if (i
>= part
->total_blocks
|| part
->blocks
[i
].offset
!= erase
->addr
||
280 erase
->addr
> UINT_MAX
) {
281 printk(KERN_ERR PREFIX
"erase callback for unknown offset %llx "
282 "on '%s'\n", (unsigned long long)erase
->addr
, part
->mbd
.mtd
->name
);
286 if (erase
->state
!= MTD_ERASE_DONE
) {
287 printk(KERN_WARNING PREFIX
"erase failed at 0x%llx on '%s', "
288 "state %d\n", (unsigned long long)erase
->addr
,
289 part
->mbd
.mtd
->name
, erase
->state
);
291 part
->blocks
[i
].state
= BLOCK_FAILED
;
292 part
->blocks
[i
].free_sectors
= 0;
293 part
->blocks
[i
].used_sectors
= 0;
300 magic
= cpu_to_le16(RFD_MAGIC
);
302 part
->blocks
[i
].state
= BLOCK_ERASED
;
303 part
->blocks
[i
].free_sectors
= part
->data_sectors_per_block
;
304 part
->blocks
[i
].used_sectors
= 0;
305 part
->blocks
[i
].erases
++;
307 rc
= part
->mbd
.mtd
->write(part
->mbd
.mtd
,
308 part
->blocks
[i
].offset
, sizeof(magic
), &retlen
,
311 if (!rc
&& retlen
!= sizeof(magic
))
315 printk(KERN_ERR PREFIX
"'%s': unable to write RFD "
318 part
->blocks
[i
].offset
);
319 part
->blocks
[i
].state
= BLOCK_FAILED
;
322 part
->blocks
[i
].state
= BLOCK_OK
;
327 static int erase_block(struct partition
*part
, int block
)
329 struct erase_info
*erase
;
332 erase
= kmalloc(sizeof(struct erase_info
), GFP_KERNEL
);
336 erase
->mtd
= part
->mbd
.mtd
;
337 erase
->callback
= erase_callback
;
338 erase
->addr
= part
->blocks
[block
].offset
;
339 erase
->len
= part
->block_size
;
340 erase
->priv
= (u_long
)part
;
342 part
->blocks
[block
].state
= BLOCK_ERASING
;
343 part
->blocks
[block
].free_sectors
= 0;
345 rc
= part
->mbd
.mtd
->erase(part
->mbd
.mtd
, erase
);
348 printk(KERN_ERR PREFIX
"erase of region %llx,%llx on '%s' "
349 "failed\n", (unsigned long long)erase
->addr
,
350 (unsigned long long)erase
->len
, part
->mbd
.mtd
->name
);
358 static int move_block_contents(struct partition
*part
, int block_no
, u_long
*old_sector
)
365 part
->is_reclaiming
= 1;
367 sector_data
= kmalloc(SECTOR_SIZE
, GFP_KERNEL
);
371 map
= kmalloc(part
->header_size
, GFP_KERNEL
);
375 rc
= part
->mbd
.mtd
->read(part
->mbd
.mtd
,
376 part
->blocks
[block_no
].offset
, part
->header_size
,
377 &retlen
, (u_char
*)map
);
379 if (!rc
&& retlen
!= part
->header_size
)
383 printk(KERN_ERR PREFIX
"error reading '%s' at "
384 "0x%lx\n", part
->mbd
.mtd
->name
,
385 part
->blocks
[block_no
].offset
);
390 for (i
=0; i
<part
->data_sectors_per_block
; i
++) {
391 u16 entry
= le16_to_cpu(map
[HEADER_MAP_OFFSET
+ i
]);
395 if (entry
== SECTOR_FREE
|| entry
== SECTOR_DELETED
)
398 if (entry
== SECTOR_ZERO
)
401 /* already warned about and ignored in build_block_map() */
402 if (entry
>= part
->sector_count
)
405 addr
= part
->blocks
[block_no
].offset
+
406 (i
+ part
->header_sectors_per_block
) * SECTOR_SIZE
;
408 if (*old_sector
== addr
) {
410 if (!part
->blocks
[block_no
].used_sectors
--) {
411 rc
= erase_block(part
, block_no
);
416 rc
= part
->mbd
.mtd
->read(part
->mbd
.mtd
, addr
,
417 SECTOR_SIZE
, &retlen
, sector_data
);
419 if (!rc
&& retlen
!= SECTOR_SIZE
)
423 printk(KERN_ERR PREFIX
"'%s': Unable to "
424 "read sector for relocation\n",
425 part
->mbd
.mtd
->name
);
430 rc
= rfd_ftl_writesect((struct mtd_blktrans_dev
*)part
,
442 part
->is_reclaiming
= 0;
447 static int reclaim_block(struct partition
*part
, u_long
*old_sector
)
449 int block
, best_block
, score
, old_sector_block
;
452 /* we have a race if sync doesn't exist */
453 if (part
->mbd
.mtd
->sync
)
454 part
->mbd
.mtd
->sync(part
->mbd
.mtd
);
456 score
= 0x7fffffff; /* MAX_INT */
458 if (*old_sector
!= -1)
459 old_sector_block
= *old_sector
/ part
->block_size
;
461 old_sector_block
= -1;
463 for (block
=0; block
<part
->total_blocks
; block
++) {
466 if (block
== part
->reserved_block
)
470 * Postpone reclaiming if there is a free sector as
471 * more removed sectors is more efficient (have to move
474 if (part
->blocks
[block
].free_sectors
)
477 this_score
= part
->blocks
[block
].used_sectors
;
479 if (block
== old_sector_block
)
482 /* no point in moving a full block */
483 if (part
->blocks
[block
].used_sectors
==
484 part
->data_sectors_per_block
)
488 this_score
+= part
->blocks
[block
].erases
;
490 if (this_score
< score
) {
496 if (best_block
== -1)
499 part
->current_block
= -1;
500 part
->reserved_block
= best_block
;
502 pr_debug("reclaim_block: reclaiming block #%d with %d used "
503 "%d free sectors\n", best_block
,
504 part
->blocks
[best_block
].used_sectors
,
505 part
->blocks
[best_block
].free_sectors
);
507 if (part
->blocks
[best_block
].used_sectors
)
508 rc
= move_block_contents(part
, best_block
, old_sector
);
510 rc
= erase_block(part
, best_block
);
516 * IMPROVE: It would be best to choose the block with the most deleted sectors,
517 * because if we fill that one up first it'll have the most chance of having
518 * the least live sectors at reclaim.
520 static int find_free_block(struct partition
*part
)
524 block
= part
->current_block
== -1 ?
525 jiffies
% part
->total_blocks
: part
->current_block
;
529 if (part
->blocks
[block
].free_sectors
&&
530 block
!= part
->reserved_block
)
533 if (part
->blocks
[block
].state
== BLOCK_UNUSED
)
534 erase_block(part
, block
);
536 if (++block
>= part
->total_blocks
)
539 } while (block
!= stop
);
544 static int find_writable_block(struct partition
*part
, u_long
*old_sector
)
549 block
= find_free_block(part
);
552 if (!part
->is_reclaiming
) {
553 rc
= reclaim_block(part
, old_sector
);
557 block
= find_free_block(part
);
566 rc
= part
->mbd
.mtd
->read(part
->mbd
.mtd
, part
->blocks
[block
].offset
,
567 part
->header_size
, &retlen
, (u_char
*)part
->header_cache
);
569 if (!rc
&& retlen
!= part
->header_size
)
573 printk(KERN_ERR PREFIX
"'%s': unable to read header at "
574 "0x%lx\n", part
->mbd
.mtd
->name
,
575 part
->blocks
[block
].offset
);
579 part
->current_block
= block
;
585 static int mark_sector_deleted(struct partition
*part
, u_long old_addr
)
587 int block
, offset
, rc
;
590 u16 del
= cpu_to_le16(SECTOR_DELETED
);
592 block
= old_addr
/ part
->block_size
;
593 offset
= (old_addr
% part
->block_size
) / SECTOR_SIZE
-
594 part
->header_sectors_per_block
;
596 addr
= part
->blocks
[block
].offset
+
597 (HEADER_MAP_OFFSET
+ offset
) * sizeof(u16
);
598 rc
= part
->mbd
.mtd
->write(part
->mbd
.mtd
, addr
,
599 sizeof(del
), &retlen
, (u_char
*)&del
);
601 if (!rc
&& retlen
!= sizeof(del
))
605 printk(KERN_ERR PREFIX
"error writing '%s' at "
606 "0x%lx\n", part
->mbd
.mtd
->name
, addr
);
610 if (block
== part
->current_block
)
611 part
->header_cache
[offset
+ HEADER_MAP_OFFSET
] = del
;
613 part
->blocks
[block
].used_sectors
--;
615 if (!part
->blocks
[block
].used_sectors
&&
616 !part
->blocks
[block
].free_sectors
)
617 rc
= erase_block(part
, block
);
623 static int find_free_sector(const struct partition
*part
, const struct block
*block
)
627 i
= stop
= part
->data_sectors_per_block
- block
->free_sectors
;
630 if (le16_to_cpu(part
->header_cache
[HEADER_MAP_OFFSET
+ i
])
634 if (++i
== part
->data_sectors_per_block
)
642 static int do_writesect(struct mtd_blktrans_dev
*dev
, u_long sector
, char *buf
, ulong
*old_addr
)
644 struct partition
*part
= (struct partition
*)dev
;
652 if (part
->current_block
== -1 ||
653 !part
->blocks
[part
->current_block
].free_sectors
) {
655 rc
= find_writable_block(part
, old_addr
);
660 block
= &part
->blocks
[part
->current_block
];
662 i
= find_free_sector(part
, block
);
669 addr
= (i
+ part
->header_sectors_per_block
) * SECTOR_SIZE
+
671 rc
= part
->mbd
.mtd
->write(part
->mbd
.mtd
,
672 addr
, SECTOR_SIZE
, &retlen
, (u_char
*)buf
);
674 if (!rc
&& retlen
!= SECTOR_SIZE
)
678 printk(KERN_ERR PREFIX
"error writing '%s' at 0x%lx\n",
679 part
->mbd
.mtd
->name
, addr
);
684 part
->sector_map
[sector
] = addr
;
686 entry
= cpu_to_le16(sector
== 0 ? SECTOR_ZERO
: sector
);
688 part
->header_cache
[i
+ HEADER_MAP_OFFSET
] = entry
;
690 addr
= block
->offset
+ (HEADER_MAP_OFFSET
+ i
) * sizeof(u16
);
691 rc
= part
->mbd
.mtd
->write(part
->mbd
.mtd
, addr
,
692 sizeof(entry
), &retlen
, (u_char
*)&entry
);
694 if (!rc
&& retlen
!= sizeof(entry
))
698 printk(KERN_ERR PREFIX
"error writing '%s' at 0x%lx\n",
699 part
->mbd
.mtd
->name
, addr
);
703 block
->used_sectors
++;
704 block
->free_sectors
--;
710 static int rfd_ftl_writesect(struct mtd_blktrans_dev
*dev
, u_long sector
, char *buf
)
712 struct partition
*part
= (struct partition
*)dev
;
717 pr_debug("rfd_ftl_writesect(sector=0x%lx)\n", sector
);
719 if (part
->reserved_block
== -1) {
724 if (sector
>= part
->sector_count
) {
729 old_addr
= part
->sector_map
[sector
];
731 for (i
=0; i
<SECTOR_SIZE
; i
++) {
735 rc
= do_writesect(dev
, sector
, buf
, &old_addr
);
741 if (i
== SECTOR_SIZE
)
742 part
->sector_map
[sector
] = -1;
745 rc
= mark_sector_deleted(part
, old_addr
);
751 static int rfd_ftl_getgeo(struct mtd_blktrans_dev
*dev
, struct hd_geometry
*geo
)
753 struct partition
*part
= (struct partition
*)dev
;
756 geo
->sectors
= SECTORS_PER_TRACK
;
757 geo
->cylinders
= part
->cylinders
;
762 static void rfd_ftl_add_mtd(struct mtd_blktrans_ops
*tr
, struct mtd_info
*mtd
)
764 struct partition
*part
;
766 if (mtd
->type
!= MTD_NORFLASH
|| mtd
->size
> UINT_MAX
)
769 part
= kzalloc(sizeof(struct partition
), GFP_KERNEL
);
776 part
->block_size
= block_size
;
778 if (!mtd
->erasesize
) {
779 printk(KERN_WARNING PREFIX
"please provide block_size");
782 part
->block_size
= mtd
->erasesize
;
785 if (scan_header(part
) == 0) {
786 part
->mbd
.size
= part
->sector_count
;
788 part
->mbd
.devnum
= -1;
789 if (!(mtd
->flags
& MTD_WRITEABLE
))
790 part
->mbd
.readonly
= 1;
791 else if (part
->errors
) {
792 printk(KERN_WARNING PREFIX
"'%s': errors found, "
793 "setting read-only\n", mtd
->name
);
794 part
->mbd
.readonly
= 1;
797 printk(KERN_INFO PREFIX
"name: '%s' type: %d flags %x\n",
798 mtd
->name
, mtd
->type
, mtd
->flags
);
800 if (!add_mtd_blktrans_dev((void*)part
))
807 static void rfd_ftl_remove_dev(struct mtd_blktrans_dev
*dev
)
809 struct partition
*part
= (struct partition
*)dev
;
812 for (i
=0; i
<part
->total_blocks
; i
++) {
813 pr_debug("rfd_ftl_remove_dev:'%s': erase unit #%02d: %d erases\n",
814 part
->mbd
.mtd
->name
, i
, part
->blocks
[i
].erases
);
817 del_mtd_blktrans_dev(dev
);
818 vfree(part
->sector_map
);
819 kfree(part
->header_cache
);
823 static struct mtd_blktrans_ops rfd_ftl_tr
= {
825 .major
= RFD_FTL_MAJOR
,
826 .part_bits
= PART_BITS
,
827 .blksize
= SECTOR_SIZE
,
829 .readsect
= rfd_ftl_readsect
,
830 .writesect
= rfd_ftl_writesect
,
831 .getgeo
= rfd_ftl_getgeo
,
832 .add_mtd
= rfd_ftl_add_mtd
,
833 .remove_dev
= rfd_ftl_remove_dev
,
834 .owner
= THIS_MODULE
,
837 static int __init
init_rfd_ftl(void)
839 return register_mtd_blktrans(&rfd_ftl_tr
);
842 static void __exit
cleanup_rfd_ftl(void)
844 deregister_mtd_blktrans(&rfd_ftl_tr
);
847 module_init(init_rfd_ftl
);
848 module_exit(cleanup_rfd_ftl
);
850 MODULE_LICENSE("GPL");
851 MODULE_AUTHOR("Sean Young <sean@mess.org>");
852 MODULE_DESCRIPTION("Support code for RFD Flash Translation Layer, "
853 "used by General Software's Embedded BIOS");