1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright © 2009 - Maxim Levitsky
4 * SmartMedia/xD translation layer
7 #include <linux/kernel.h>
8 #include <linux/module.h>
9 #include <linux/random.h>
10 #include <linux/hdreg.h>
11 #include <linux/kthread.h>
12 #include <linux/freezer.h>
13 #include <linux/sysfs.h>
14 #include <linux/bitops.h>
15 #include <linux/slab.h>
16 #include <linux/mtd/nand_ecc.h>
17 #include "nand/raw/sm_common.h"
22 static struct workqueue_struct *cache_flush_workqueue;
24 static int cache_timeout = 1000;
25 module_param(cache_timeout, int, S_IRUGO);
26 MODULE_PARM_DESC(cache_timeout,
27 "Timeout (in ms) for cache flush (1000 ms default");
30 module_param(debug, int, S_IRUGO | S_IWUSR);
31 MODULE_PARM_DESC(debug, "Debug level (0-2)");
34 /* ------------------- sysfs attributes ---------------------------------- */
35 struct sm_sysfs_attribute {
36 struct device_attribute dev_attr;
41 static ssize_t sm_attr_show(struct device *dev, struct device_attribute *attr,
44 struct sm_sysfs_attribute *sm_attr =
45 container_of(attr, struct sm_sysfs_attribute, dev_attr);
47 strncpy(buf, sm_attr->data, sm_attr->len);
52 #define NUM_ATTRIBUTES 1
53 #define SM_CIS_VENDOR_OFFSET 0x59
54 static struct attribute_group *sm_create_sysfs_attributes(struct sm_ftl *ftl)
56 struct attribute_group *attr_group;
57 struct attribute **attributes;
58 struct sm_sysfs_attribute *vendor_attribute;
61 vendor = kstrndup(ftl->cis_buffer + SM_CIS_VENDOR_OFFSET,
62 SM_SMALL_PAGE - SM_CIS_VENDOR_OFFSET, GFP_KERNEL);
66 /* Initialize sysfs attributes */
68 kzalloc(sizeof(struct sm_sysfs_attribute), GFP_KERNEL);
69 if (!vendor_attribute)
72 sysfs_attr_init(&vendor_attribute->dev_attr.attr);
74 vendor_attribute->data = vendor;
75 vendor_attribute->len = strlen(vendor);
76 vendor_attribute->dev_attr.attr.name = "vendor";
77 vendor_attribute->dev_attr.attr.mode = S_IRUGO;
78 vendor_attribute->dev_attr.show = sm_attr_show;
81 /* Create array of pointers to the attributes */
82 attributes = kcalloc(NUM_ATTRIBUTES + 1, sizeof(struct attribute *),
86 attributes[0] = &vendor_attribute->dev_attr.attr;
88 /* Finally create the attribute group */
89 attr_group = kzalloc(sizeof(struct attribute_group), GFP_KERNEL);
92 attr_group->attrs = attributes;
97 kfree(vendor_attribute);
104 static void sm_delete_sysfs_attributes(struct sm_ftl *ftl)
106 struct attribute **attributes = ftl->disk_attributes->attrs;
109 for (i = 0; attributes[i] ; i++) {
111 struct device_attribute *dev_attr = container_of(attributes[i],
112 struct device_attribute, attr);
114 struct sm_sysfs_attribute *sm_attr =
115 container_of(dev_attr,
116 struct sm_sysfs_attribute, dev_attr);
118 kfree(sm_attr->data);
122 kfree(ftl->disk_attributes->attrs);
123 kfree(ftl->disk_attributes);
127 /* ----------------------- oob helpers -------------------------------------- */
129 static int sm_get_lba(uint8_t *lba)
131 /* check fixed bits */
132 if ((lba[0] & 0xF8) != 0x10)
135 /* check parity - endianness doesn't matter */
136 if (hweight16(*(uint16_t *)lba) & 1)
139 return (lba[1] >> 1) | ((lba[0] & 0x07) << 7);
144 * Read LBA associated with block
145 * returns -1, if block is erased
146 * returns -2 if error happens
148 static int sm_read_lba(struct sm_oob *oob)
150 static const uint32_t erased_pattern[4] = {
151 0xFFFFFFFF, 0xFFFFFFFF, 0xFFFFFFFF, 0xFFFFFFFF };
156 /* First test for erased block */
157 if (!memcmp(oob, erased_pattern, SM_OOB_SIZE))
160 /* Now check is both copies of the LBA differ too much */
161 lba_test = *(uint16_t *)oob->lba_copy1 ^ *(uint16_t*)oob->lba_copy2;
162 if (lba_test && !is_power_of_2(lba_test))
166 lba = sm_get_lba(oob->lba_copy1);
169 lba = sm_get_lba(oob->lba_copy2);
174 static void sm_write_lba(struct sm_oob *oob, uint16_t lba)
178 WARN_ON(lba >= 1000);
180 tmp[0] = 0x10 | ((lba >> 7) & 0x07);
181 tmp[1] = (lba << 1) & 0xFF;
183 if (hweight16(*(uint16_t *)tmp) & 0x01)
186 oob->lba_copy1[0] = oob->lba_copy2[0] = tmp[0];
187 oob->lba_copy1[1] = oob->lba_copy2[1] = tmp[1];
191 /* Make offset from parts */
192 static loff_t sm_mkoffset(struct sm_ftl *ftl, int zone, int block, int boffset)
194 WARN_ON(boffset & (SM_SECTOR_SIZE - 1));
195 WARN_ON(zone < 0 || zone >= ftl->zone_count);
196 WARN_ON(block >= ftl->zone_size);
197 WARN_ON(boffset >= ftl->block_size);
202 return (zone * SM_MAX_ZONE_SIZE + block) * ftl->block_size + boffset;
205 /* Breaks offset into parts */
206 static void sm_break_offset(struct sm_ftl *ftl, loff_t loffset,
207 int *zone, int *block, int *boffset)
209 u64 offset = loffset;
210 *boffset = do_div(offset, ftl->block_size);
211 *block = do_div(offset, ftl->max_lba);
212 *zone = offset >= ftl->zone_count ? -1 : offset;
215 /* ---------------------- low level IO ------------------------------------- */
217 static int sm_correct_sector(uint8_t *buffer, struct sm_oob *oob)
221 __nand_calculate_ecc(buffer, SM_SMALL_PAGE, ecc,
222 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC));
223 if (__nand_correct_data(buffer, ecc, oob->ecc1, SM_SMALL_PAGE,
224 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC)) < 0)
227 buffer += SM_SMALL_PAGE;
229 __nand_calculate_ecc(buffer, SM_SMALL_PAGE, ecc,
230 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC));
231 if (__nand_correct_data(buffer, ecc, oob->ecc2, SM_SMALL_PAGE,
232 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC)) < 0)
237 /* Reads a sector + oob*/
238 static int sm_read_sector(struct sm_ftl *ftl,
239 int zone, int block, int boffset,
240 uint8_t *buffer, struct sm_oob *oob)
242 struct mtd_info *mtd = ftl->trans->mtd;
243 struct mtd_oob_ops ops;
244 struct sm_oob tmp_oob;
248 /* FTL can contain -1 entries that are by default filled with bits */
250 memset(buffer, 0xFF, SM_SECTOR_SIZE);
254 /* User might not need the oob, but we do for data verification */
258 ops.mode = ftl->smallpagenand ? MTD_OPS_RAW : MTD_OPS_PLACE_OOB;
260 ops.ooblen = SM_OOB_SIZE;
261 ops.oobbuf = (void *)oob;
262 ops.len = SM_SECTOR_SIZE;
267 /* Avoid infinite recursion on CIS reads, sm_recheck_media
269 if (zone == 0 && block == ftl->cis_block && boffset ==
273 /* Test if media is stable */
274 if (try == 3 || sm_recheck_media(ftl))
278 /* Unfortunately, oob read will _always_ succeed,
279 despite card removal..... */
280 ret = mtd_read_oob(mtd, sm_mkoffset(ftl, zone, block, boffset), &ops);
282 /* Test for unknown errors */
283 if (ret != 0 && !mtd_is_bitflip_or_eccerr(ret)) {
284 dbg("read of block %d at zone %d, failed due to error (%d)",
289 /* Do a basic test on the oob, to guard against returned garbage */
290 if (oob->reserved != 0xFFFFFFFF && !is_power_of_2(~oob->reserved))
293 /* This should never happen, unless there is a bug in the mtd driver */
294 WARN_ON(ops.oobretlen != SM_OOB_SIZE);
295 WARN_ON(buffer && ops.retlen != SM_SECTOR_SIZE);
300 /* Test if sector marked as bad */
301 if (!sm_sector_valid(oob)) {
302 dbg("read of block %d at zone %d, failed because it is marked"
303 " as bad" , block, zone);
308 if (mtd_is_eccerr(ret) ||
309 (ftl->smallpagenand && sm_correct_sector(buffer, oob))) {
311 dbg("read of block %d at zone %d, failed due to ECC error",
319 /* Writes a sector to media */
320 static int sm_write_sector(struct sm_ftl *ftl,
321 int zone, int block, int boffset,
322 uint8_t *buffer, struct sm_oob *oob)
324 struct mtd_oob_ops ops;
325 struct mtd_info *mtd = ftl->trans->mtd;
328 BUG_ON(ftl->readonly);
330 if (zone == 0 && (block == ftl->cis_block || block == 0)) {
331 dbg("attempted to write the CIS!");
338 ops.mode = ftl->smallpagenand ? MTD_OPS_RAW : MTD_OPS_PLACE_OOB;
339 ops.len = SM_SECTOR_SIZE;
342 ops.ooblen = SM_OOB_SIZE;
343 ops.oobbuf = (void *)oob;
345 ret = mtd_write_oob(mtd, sm_mkoffset(ftl, zone, block, boffset), &ops);
347 /* Now we assume that hardware will catch write bitflip errors */
350 dbg("write to block %d at zone %d, failed with error %d",
353 sm_recheck_media(ftl);
357 /* This should never happen, unless there is a bug in the driver */
358 WARN_ON(ops.oobretlen != SM_OOB_SIZE);
359 WARN_ON(buffer && ops.retlen != SM_SECTOR_SIZE);
364 /* ------------------------ block IO ------------------------------------- */
366 /* Write a block using data and lba, and invalid sector bitmap */
367 static int sm_write_block(struct sm_ftl *ftl, uint8_t *buf,
368 int zone, int block, int lba,
369 unsigned long invalid_bitmap)
375 /* Initialize the oob with requested values */
376 memset(&oob, 0xFF, SM_OOB_SIZE);
377 sm_write_lba(&oob, lba);
382 for (boffset = 0; boffset < ftl->block_size;
383 boffset += SM_SECTOR_SIZE) {
385 oob.data_status = 0xFF;
387 if (test_bit(boffset / SM_SECTOR_SIZE, &invalid_bitmap)) {
389 sm_printk("sector %d of block at LBA %d of zone %d"
390 " couldn't be read, marking it as invalid",
391 boffset / SM_SECTOR_SIZE, lba, zone);
396 if (ftl->smallpagenand) {
397 __nand_calculate_ecc(buf + boffset, SM_SMALL_PAGE,
399 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC));
401 __nand_calculate_ecc(buf + boffset + SM_SMALL_PAGE,
402 SM_SMALL_PAGE, oob.ecc2,
403 IS_ENABLED(CONFIG_MTD_NAND_ECC_SW_HAMMING_SMC));
405 if (!sm_write_sector(ftl, zone, block, boffset,
406 buf + boffset, &oob))
411 /* If write fails. try to erase the block */
412 /* This is safe, because we never write in blocks
413 that contain valuable data.
414 This is intended to repair block that are marked
415 as erased, but that isn't fully erased*/
417 if (sm_erase_block(ftl, zone, block, 0))
423 sm_mark_block_bad(ftl, zone, block);
431 /* Mark whole block at offset 'offs' as bad. */
432 static void sm_mark_block_bad(struct sm_ftl *ftl, int zone, int block)
437 memset(&oob, 0xFF, SM_OOB_SIZE);
438 oob.block_status = 0xF0;
443 if (sm_recheck_media(ftl))
446 sm_printk("marking block %d of zone %d as bad", block, zone);
448 /* We aren't checking the return value, because we don't care */
449 /* This also fails on fake xD cards, but I guess these won't expose
450 any bad blocks till fail completely */
451 for (boffset = 0; boffset < ftl->block_size; boffset += SM_SECTOR_SIZE)
452 sm_write_sector(ftl, zone, block, boffset, NULL, &oob);
456 * Erase a block within a zone
457 * If erase succeeds, it updates free block fifo, otherwise marks block as bad
459 static int sm_erase_block(struct sm_ftl *ftl, int zone_num, uint16_t block,
462 struct ftl_zone *zone = &ftl->zones[zone_num];
463 struct mtd_info *mtd = ftl->trans->mtd;
464 struct erase_info erase;
466 erase.addr = sm_mkoffset(ftl, zone_num, block, 0);
467 erase.len = ftl->block_size;
472 BUG_ON(ftl->readonly);
474 if (zone_num == 0 && (block == ftl->cis_block || block == 0)) {
475 sm_printk("attempted to erase the CIS!");
479 if (mtd_erase(mtd, &erase)) {
480 sm_printk("erase of block %d in zone %d failed",
486 kfifo_in(&zone->free_sectors,
487 (const unsigned char *)&block, sizeof(block));
491 sm_mark_block_bad(ftl, zone_num, block);
495 /* Thoroughly test that block is valid. */
496 static int sm_check_block(struct sm_ftl *ftl, int zone, int block)
500 int lbas[] = { -3, 0, 0, 0 };
505 /* First just check that block doesn't look fishy */
506 /* Only blocks that are valid or are sliced in two parts, are
508 for (boffset = 0; boffset < ftl->block_size;
509 boffset += SM_SECTOR_SIZE) {
511 /* This shouldn't happen anyway */
512 if (sm_read_sector(ftl, zone, block, boffset, NULL, &oob))
515 test_lba = sm_read_lba(&oob);
517 if (lbas[i] != test_lba)
518 lbas[++i] = test_lba;
520 /* If we found three different LBAs, something is fishy */
525 /* If the block is sliced (partially erased usually) erase it */
527 sm_erase_block(ftl, zone, block, 1);
534 /* ----------------- media scanning --------------------------------- */
535 static const struct chs_entry chs_table[] = {
543 { 128, 500, 16, 32 },
544 { 256, 1000, 16, 32 },
545 { 512, 1015, 32, 63 },
546 { 1024, 985, 33, 63 },
547 { 2048, 985, 33, 63 },
552 static const uint8_t cis_signature[] = {
553 0x01, 0x03, 0xD9, 0x01, 0xFF, 0x18, 0x02, 0xDF, 0x01, 0x20
555 /* Find out media parameters.
556 * This ideally has to be based on nand id, but for now device size is enough */
557 static int sm_get_media_info(struct sm_ftl *ftl, struct mtd_info *mtd)
560 int size_in_megs = mtd->size / (1024 * 1024);
562 ftl->readonly = mtd->type == MTD_ROM;
564 /* Manual settings for very old devices */
566 ftl->smallpagenand = 0;
568 switch (size_in_megs) {
570 /* 1 MiB flash/rom SmartMedia card (256 byte pages)*/
571 ftl->zone_size = 256;
573 ftl->block_size = 8 * SM_SECTOR_SIZE;
574 ftl->smallpagenand = 1;
578 /* 2 MiB flash SmartMedia (256 byte pages)*/
579 if (mtd->writesize == SM_SMALL_PAGE) {
580 ftl->zone_size = 512;
582 ftl->block_size = 8 * SM_SECTOR_SIZE;
583 ftl->smallpagenand = 1;
584 /* 2 MiB rom SmartMedia */
590 ftl->zone_size = 256;
592 ftl->block_size = 16 * SM_SECTOR_SIZE;
596 /* 4 MiB flash/rom SmartMedia device */
597 ftl->zone_size = 512;
599 ftl->block_size = 16 * SM_SECTOR_SIZE;
602 /* 8 MiB flash/rom SmartMedia device */
603 ftl->zone_size = 1024;
605 ftl->block_size = 16 * SM_SECTOR_SIZE;
608 /* Minimum xD size is 16MiB. Also, all xD cards have standard zone
609 sizes. SmartMedia cards exist up to 128 MiB and have same layout*/
610 if (size_in_megs >= 16) {
611 ftl->zone_count = size_in_megs / 16;
612 ftl->zone_size = 1024;
614 ftl->block_size = 32 * SM_SECTOR_SIZE;
617 /* Test for proper write,erase and oob sizes */
618 if (mtd->erasesize > ftl->block_size)
621 if (mtd->writesize > SM_SECTOR_SIZE)
624 if (ftl->smallpagenand && mtd->oobsize < SM_SMALL_OOB_SIZE)
627 if (!ftl->smallpagenand && mtd->oobsize < SM_OOB_SIZE)
631 if (!mtd_has_oob(mtd))
634 /* Find geometry information */
635 for (i = 0 ; i < ARRAY_SIZE(chs_table) ; i++) {
636 if (chs_table[i].size == size_in_megs) {
637 ftl->cylinders = chs_table[i].cyl;
638 ftl->heads = chs_table[i].head;
639 ftl->sectors = chs_table[i].sec;
644 sm_printk("media has unknown size : %dMiB", size_in_megs);
645 ftl->cylinders = 985;
651 /* Validate the CIS */
652 static int sm_read_cis(struct sm_ftl *ftl)
656 if (sm_read_sector(ftl,
657 0, ftl->cis_block, ftl->cis_boffset, ftl->cis_buffer, &oob))
660 if (!sm_sector_valid(&oob) || !sm_block_valid(&oob))
663 if (!memcmp(ftl->cis_buffer + ftl->cis_page_offset,
664 cis_signature, sizeof(cis_signature))) {
671 /* Scan the media for the CIS */
672 static int sm_find_cis(struct sm_ftl *ftl)
679 /* Search for first valid block */
680 for (block = 0 ; block < ftl->zone_size - ftl->max_lba ; block++) {
682 if (sm_read_sector(ftl, 0, block, 0, NULL, &oob))
685 if (!sm_block_valid(&oob))
694 /* Search for first valid sector in this block */
695 for (boffset = 0 ; boffset < ftl->block_size;
696 boffset += SM_SECTOR_SIZE) {
698 if (sm_read_sector(ftl, 0, block, boffset, NULL, &oob))
701 if (!sm_sector_valid(&oob))
706 if (boffset == ftl->block_size)
709 ftl->cis_block = block;
710 ftl->cis_boffset = boffset;
711 ftl->cis_page_offset = 0;
713 cis_found = !sm_read_cis(ftl);
716 ftl->cis_page_offset = SM_SMALL_PAGE;
717 cis_found = !sm_read_cis(ftl);
721 dbg("CIS block found at offset %x",
722 block * ftl->block_size +
723 boffset + ftl->cis_page_offset);
729 /* Basic test to determine if underlying mtd device if functional */
730 static int sm_recheck_media(struct sm_ftl *ftl)
732 if (sm_read_cis(ftl)) {
734 if (!ftl->unstable) {
735 sm_printk("media unstable, not allowing writes");
743 /* Initialize a FTL zone */
744 static int sm_init_zone(struct sm_ftl *ftl, int zone_num)
746 struct ftl_zone *zone = &ftl->zones[zone_num];
753 dbg("initializing zone %d", zone_num);
755 /* Allocate memory for FTL table */
756 zone->lba_to_phys_table = kmalloc_array(ftl->max_lba, 2, GFP_KERNEL);
758 if (!zone->lba_to_phys_table)
760 memset(zone->lba_to_phys_table, -1, ftl->max_lba * 2);
763 /* Allocate memory for free sectors FIFO */
764 if (kfifo_alloc(&zone->free_sectors, ftl->zone_size * 2, GFP_KERNEL)) {
765 kfree(zone->lba_to_phys_table);
769 /* Now scan the zone */
770 for (block = 0 ; block < ftl->zone_size ; block++) {
772 /* Skip blocks till the CIS (including) */
773 if (zone_num == 0 && block <= ftl->cis_block)
776 /* Read the oob of first sector */
777 if (sm_read_sector(ftl, zone_num, block, 0, NULL, &oob))
780 /* Test to see if block is erased. It is enough to test
781 first sector, because erase happens in one shot */
782 if (sm_block_erased(&oob)) {
783 kfifo_in(&zone->free_sectors,
784 (unsigned char *)&block, 2);
788 /* If block is marked as bad, skip it */
789 /* This assumes we can trust first sector*/
790 /* However the way the block valid status is defined, ensures
791 very low probability of failure here */
792 if (!sm_block_valid(&oob)) {
793 dbg("PH %04d <-> <marked bad>", block);
798 lba = sm_read_lba(&oob);
800 /* Invalid LBA means that block is damaged. */
801 /* We can try to erase it, or mark it as bad, but
802 lets leave that to recovery application */
803 if (lba == -2 || lba >= ftl->max_lba) {
804 dbg("PH %04d <-> LBA %04d(bad)", block, lba);
809 /* If there is no collision,
810 just put the sector in the FTL table */
811 if (zone->lba_to_phys_table[lba] < 0) {
812 dbg_verbose("PH %04d <-> LBA %04d", block, lba);
813 zone->lba_to_phys_table[lba] = block;
817 sm_printk("collision"
818 " of LBA %d between blocks %d and %d in zone %d",
819 lba, zone->lba_to_phys_table[lba], block, zone_num);
821 /* Test that this block is valid*/
822 if (sm_check_block(ftl, zone_num, block))
825 /* Test now the old block */
826 if (sm_check_block(ftl, zone_num,
827 zone->lba_to_phys_table[lba])) {
828 zone->lba_to_phys_table[lba] = block;
832 /* If both blocks are valid and share same LBA, it means that
833 they hold different versions of same data. It not
834 known which is more recent, thus just erase one of them
836 sm_printk("both blocks are valid, erasing the later");
837 sm_erase_block(ftl, zone_num, block, 1);
840 dbg("zone initialized");
841 zone->initialized = 1;
843 /* No free sectors, means that the zone is heavily damaged, write won't
844 work, but it can still can be (partially) read */
845 if (!kfifo_len(&zone->free_sectors)) {
846 sm_printk("no free blocks in zone %d", zone_num);
850 /* Randomize first block we write to */
851 get_random_bytes(&i, 2);
852 i %= (kfifo_len(&zone->free_sectors) / 2);
855 len = kfifo_out(&zone->free_sectors,
856 (unsigned char *)&block, 2);
858 kfifo_in(&zone->free_sectors, (const unsigned char *)&block, 2);
863 /* Get and automatically initialize an FTL mapping for one zone */
864 static struct ftl_zone *sm_get_zone(struct sm_ftl *ftl, int zone_num)
866 struct ftl_zone *zone;
869 BUG_ON(zone_num >= ftl->zone_count);
870 zone = &ftl->zones[zone_num];
872 if (!zone->initialized) {
873 error = sm_init_zone(ftl, zone_num);
876 return ERR_PTR(error);
882 /* ----------------- cache handling ------------------------------------------*/
884 /* Initialize the one block cache */
885 static void sm_cache_init(struct sm_ftl *ftl)
887 ftl->cache_data_invalid_bitmap = 0xFFFFFFFF;
888 ftl->cache_clean = 1;
889 ftl->cache_zone = -1;
890 ftl->cache_block = -1;
891 /*memset(ftl->cache_data, 0xAA, ftl->block_size);*/
894 /* Put sector in one block cache */
895 static void sm_cache_put(struct sm_ftl *ftl, char *buffer, int boffset)
897 memcpy(ftl->cache_data + boffset, buffer, SM_SECTOR_SIZE);
898 clear_bit(boffset / SM_SECTOR_SIZE, &ftl->cache_data_invalid_bitmap);
899 ftl->cache_clean = 0;
902 /* Read a sector from the cache */
903 static int sm_cache_get(struct sm_ftl *ftl, char *buffer, int boffset)
905 if (test_bit(boffset / SM_SECTOR_SIZE,
906 &ftl->cache_data_invalid_bitmap))
909 memcpy(buffer, ftl->cache_data + boffset, SM_SECTOR_SIZE);
913 /* Write the cache to hardware */
914 static int sm_cache_flush(struct sm_ftl *ftl)
916 struct ftl_zone *zone;
919 uint16_t write_sector;
920 int zone_num = ftl->cache_zone;
923 if (ftl->cache_clean)
929 BUG_ON(zone_num < 0);
930 zone = &ftl->zones[zone_num];
931 block_num = zone->lba_to_phys_table[ftl->cache_block];
934 /* Try to read all unread areas of the cache block*/
935 for_each_set_bit(sector_num, &ftl->cache_data_invalid_bitmap,
936 ftl->block_size / SM_SECTOR_SIZE) {
938 if (!sm_read_sector(ftl,
939 zone_num, block_num, sector_num * SM_SECTOR_SIZE,
940 ftl->cache_data + sector_num * SM_SECTOR_SIZE, NULL))
941 clear_bit(sector_num,
942 &ftl->cache_data_invalid_bitmap);
949 /* If there are no spare blocks, */
950 /* we could still continue by erasing/writing the current block,
951 but for such worn out media it doesn't worth the trouble,
953 if (kfifo_out(&zone->free_sectors,
954 (unsigned char *)&write_sector, 2) != 2) {
955 dbg("no free sectors for write!");
960 if (sm_write_block(ftl, ftl->cache_data, zone_num, write_sector,
961 ftl->cache_block, ftl->cache_data_invalid_bitmap))
964 /* Update the FTL table */
965 zone->lba_to_phys_table[ftl->cache_block] = write_sector;
967 /* Write succesfull, so erase and free the old block */
969 sm_erase_block(ftl, zone_num, block_num, 1);
976 /* flush timer, runs a second after last write */
977 static void sm_cache_flush_timer(struct timer_list *t)
979 struct sm_ftl *ftl = from_timer(ftl, t, timer);
980 queue_work(cache_flush_workqueue, &ftl->flush_work);
983 /* cache flush work, kicked by timer */
984 static void sm_cache_flush_work(struct work_struct *work)
986 struct sm_ftl *ftl = container_of(work, struct sm_ftl, flush_work);
987 mutex_lock(&ftl->mutex);
989 mutex_unlock(&ftl->mutex);
993 /* ---------------- outside interface -------------------------------------- */
995 /* outside interface: read a sector */
996 static int sm_read(struct mtd_blktrans_dev *dev,
997 unsigned long sect_no, char *buf)
999 struct sm_ftl *ftl = dev->priv;
1000 struct ftl_zone *zone;
1001 int error = 0, in_cache = 0;
1002 int zone_num, block, boffset;
1004 sm_break_offset(ftl, sect_no << 9, &zone_num, &block, &boffset);
1005 mutex_lock(&ftl->mutex);
1008 zone = sm_get_zone(ftl, zone_num);
1010 error = PTR_ERR(zone);
1014 /* Have to look at cache first */
1015 if (ftl->cache_zone == zone_num && ftl->cache_block == block) {
1017 if (!sm_cache_get(ftl, buf, boffset))
1021 /* Translate the block and return if doesn't exist in the table */
1022 block = zone->lba_to_phys_table[block];
1025 memset(buf, 0xFF, SM_SECTOR_SIZE);
1029 if (sm_read_sector(ftl, zone_num, block, boffset, buf, NULL)) {
1035 sm_cache_put(ftl, buf, boffset);
1037 mutex_unlock(&ftl->mutex);
1041 /* outside interface: write a sector */
1042 static int sm_write(struct mtd_blktrans_dev *dev,
1043 unsigned long sec_no, char *buf)
1045 struct sm_ftl *ftl = dev->priv;
1046 struct ftl_zone *zone;
1047 int error = 0, zone_num, block, boffset;
1049 BUG_ON(ftl->readonly);
1050 sm_break_offset(ftl, sec_no << 9, &zone_num, &block, &boffset);
1052 /* No need in flush thread running now */
1053 del_timer(&ftl->timer);
1054 mutex_lock(&ftl->mutex);
1056 zone = sm_get_zone(ftl, zone_num);
1058 error = PTR_ERR(zone);
1062 /* If entry is not in cache, flush it */
1063 if (ftl->cache_block != block || ftl->cache_zone != zone_num) {
1065 error = sm_cache_flush(ftl);
1069 ftl->cache_block = block;
1070 ftl->cache_zone = zone_num;
1073 sm_cache_put(ftl, buf, boffset);
1075 mod_timer(&ftl->timer, jiffies + msecs_to_jiffies(cache_timeout));
1076 mutex_unlock(&ftl->mutex);
1080 /* outside interface: flush everything */
1081 static int sm_flush(struct mtd_blktrans_dev *dev)
1083 struct sm_ftl *ftl = dev->priv;
1086 mutex_lock(&ftl->mutex);
1087 retval = sm_cache_flush(ftl);
1088 mutex_unlock(&ftl->mutex);
1092 /* outside interface: device is released */
1093 static void sm_release(struct mtd_blktrans_dev *dev)
1095 struct sm_ftl *ftl = dev->priv;
1097 mutex_lock(&ftl->mutex);
1098 del_timer_sync(&ftl->timer);
1099 cancel_work_sync(&ftl->flush_work);
1100 sm_cache_flush(ftl);
1101 mutex_unlock(&ftl->mutex);
1104 /* outside interface: get geometry */
1105 static int sm_getgeo(struct mtd_blktrans_dev *dev, struct hd_geometry *geo)
1107 struct sm_ftl *ftl = dev->priv;
1108 geo->heads = ftl->heads;
1109 geo->sectors = ftl->sectors;
1110 geo->cylinders = ftl->cylinders;
1114 /* external interface: main initialization function */
1115 static void sm_add_mtd(struct mtd_blktrans_ops *tr, struct mtd_info *mtd)
1117 struct mtd_blktrans_dev *trans;
1120 /* Allocate & initialize our private structure */
1121 ftl = kzalloc(sizeof(struct sm_ftl), GFP_KERNEL);
1126 mutex_init(&ftl->mutex);
1127 timer_setup(&ftl->timer, sm_cache_flush_timer, 0);
1128 INIT_WORK(&ftl->flush_work, sm_cache_flush_work);
1130 /* Read media information */
1131 if (sm_get_media_info(ftl, mtd)) {
1132 dbg("found unsupported mtd device, aborting");
1137 /* Allocate temporary CIS buffer for read retry support */
1138 ftl->cis_buffer = kzalloc(SM_SECTOR_SIZE, GFP_KERNEL);
1139 if (!ftl->cis_buffer)
1142 /* Allocate zone array, it will be initialized on demand */
1143 ftl->zones = kcalloc(ftl->zone_count, sizeof(struct ftl_zone),
1148 /* Allocate the cache*/
1149 ftl->cache_data = kzalloc(ftl->block_size, GFP_KERNEL);
1151 if (!ftl->cache_data)
1157 /* Allocate upper layer structure and initialize it */
1158 trans = kzalloc(sizeof(struct mtd_blktrans_dev), GFP_KERNEL);
1168 trans->size = (ftl->block_size * ftl->max_lba * ftl->zone_count) >> 9;
1169 trans->readonly = ftl->readonly;
1171 if (sm_find_cis(ftl)) {
1172 dbg("CIS not found on mtd device, aborting");
1176 ftl->disk_attributes = sm_create_sysfs_attributes(ftl);
1177 if (!ftl->disk_attributes)
1179 trans->disk_attributes = ftl->disk_attributes;
1181 sm_printk("Found %d MiB xD/SmartMedia FTL on mtd%d",
1182 (int)(mtd->size / (1024 * 1024)), mtd->index);
1185 dbg("%d zone(s), each consists of %d blocks (+%d spares)",
1186 ftl->zone_count, ftl->max_lba,
1187 ftl->zone_size - ftl->max_lba);
1188 dbg("each block consists of %d bytes",
1192 /* Register device*/
1193 if (add_mtd_blktrans_dev(trans)) {
1194 dbg("error in mtdblktrans layer");
1201 kfree(ftl->cache_data);
1205 kfree(ftl->cis_buffer);
1212 /* main interface: device {surprise,} removal */
1213 static void sm_remove_dev(struct mtd_blktrans_dev *dev)
1215 struct sm_ftl *ftl = dev->priv;
1218 del_mtd_blktrans_dev(dev);
1221 for (i = 0 ; i < ftl->zone_count; i++) {
1223 if (!ftl->zones[i].initialized)
1226 kfree(ftl->zones[i].lba_to_phys_table);
1227 kfifo_free(&ftl->zones[i].free_sectors);
1230 sm_delete_sysfs_attributes(ftl);
1231 kfree(ftl->cis_buffer);
1233 kfree(ftl->cache_data);
1237 static struct mtd_blktrans_ops sm_ftl_ops = {
1240 .part_bits = SM_FTL_PARTN_BITS,
1241 .blksize = SM_SECTOR_SIZE,
1242 .getgeo = sm_getgeo,
1244 .add_mtd = sm_add_mtd,
1245 .remove_dev = sm_remove_dev,
1247 .readsect = sm_read,
1248 .writesect = sm_write,
1251 .release = sm_release,
1253 .owner = THIS_MODULE,
1256 static __init int sm_module_init(void)
1260 cache_flush_workqueue = create_freezable_workqueue("smflush");
1261 if (!cache_flush_workqueue)
1264 error = register_mtd_blktrans(&sm_ftl_ops);
1266 destroy_workqueue(cache_flush_workqueue);
1271 static void __exit sm_module_exit(void)
1273 destroy_workqueue(cache_flush_workqueue);
1274 deregister_mtd_blktrans(&sm_ftl_ops);
1277 module_init(sm_module_init);
1278 module_exit(sm_module_exit);
1280 MODULE_LICENSE("GPL");
1281 MODULE_AUTHOR("Maxim Levitsky <maximlevitsky@gmail.com>");
1282 MODULE_DESCRIPTION("Smartmedia/xD mtd translation layer");