xref: /OK3568_Linux_fs/kernel/drivers/mtd/sm_ftl.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright © 2009 - Maxim Levitsky
4*4882a593Smuzhiyun  * SmartMedia/xD translation layer
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Based loosly on ssfdc.c which is
7*4882a593Smuzhiyun  *  © 2005 Eptar srl
8*4882a593Smuzhiyun  *  Author: Claudio Lanconelli <lanconelli.claudio@eptar.com>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/mtd/blktrans.h>
12*4882a593Smuzhiyun #include <linux/kfifo.h>
13*4882a593Smuzhiyun #include <linux/sched.h>
14*4882a593Smuzhiyun #include <linux/completion.h>
15*4882a593Smuzhiyun #include <linux/mtd/mtd.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun struct ftl_zone {
20*4882a593Smuzhiyun 	bool initialized;
21*4882a593Smuzhiyun 	int16_t *lba_to_phys_table;		/* LBA to physical table */
22*4882a593Smuzhiyun 	struct kfifo free_sectors;	/* queue of free sectors */
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun struct sm_ftl {
26*4882a593Smuzhiyun 	struct mtd_blktrans_dev *trans;
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun 	struct mutex mutex;		/* protects the structure */
29*4882a593Smuzhiyun 	struct ftl_zone *zones;		/* FTL tables for each zone */
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	/* Media information */
32*4882a593Smuzhiyun 	int block_size;			/* block size in bytes */
33*4882a593Smuzhiyun 	int zone_size;			/* zone size in blocks */
34*4882a593Smuzhiyun 	int zone_count;			/* number of zones */
35*4882a593Smuzhiyun 	int max_lba;			/* maximum lba in a zone */
36*4882a593Smuzhiyun 	int smallpagenand;		/* 256 bytes/page nand */
37*4882a593Smuzhiyun 	bool readonly;			/* is FS readonly */
38*4882a593Smuzhiyun 	bool unstable;
39*4882a593Smuzhiyun 	int cis_block;			/* CIS block location */
40*4882a593Smuzhiyun 	int cis_boffset;		/* CIS offset in the block */
41*4882a593Smuzhiyun 	int cis_page_offset;		/* CIS offset in the page */
42*4882a593Smuzhiyun 	void *cis_buffer;		/* tmp buffer for cis reads */
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	/* Cache */
45*4882a593Smuzhiyun 	int cache_block;		/* block number of cached block */
46*4882a593Smuzhiyun 	int cache_zone;			/* zone of cached block */
47*4882a593Smuzhiyun 	unsigned char *cache_data;	/* cached block data */
48*4882a593Smuzhiyun 	long unsigned int cache_data_invalid_bitmap;
49*4882a593Smuzhiyun 	bool cache_clean;
50*4882a593Smuzhiyun 	struct work_struct flush_work;
51*4882a593Smuzhiyun 	struct timer_list timer;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	/* Geometry stuff */
54*4882a593Smuzhiyun 	int heads;
55*4882a593Smuzhiyun 	int sectors;
56*4882a593Smuzhiyun 	int cylinders;
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 	struct attribute_group *disk_attributes;
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun struct chs_entry {
62*4882a593Smuzhiyun 	unsigned long size;
63*4882a593Smuzhiyun 	unsigned short cyl;
64*4882a593Smuzhiyun 	unsigned char head;
65*4882a593Smuzhiyun 	unsigned char sec;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun #define SM_FTL_PARTN_BITS	3
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun #define sm_printk(format, ...) \
72*4882a593Smuzhiyun 	printk(KERN_WARNING "sm_ftl" ": " format "\n", ## __VA_ARGS__)
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define dbg(format, ...) \
75*4882a593Smuzhiyun 	if (debug) \
76*4882a593Smuzhiyun 		printk(KERN_DEBUG "sm_ftl" ": " format "\n", ## __VA_ARGS__)
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #define dbg_verbose(format, ...) \
79*4882a593Smuzhiyun 	if (debug > 1) \
80*4882a593Smuzhiyun 		printk(KERN_DEBUG "sm_ftl" ": " format "\n", ## __VA_ARGS__)
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun static int sm_erase_block(struct sm_ftl *ftl, int zone_num, uint16_t block,
84*4882a593Smuzhiyun 								int put_free);
85*4882a593Smuzhiyun static void sm_mark_block_bad(struct sm_ftl *ftl, int zone_num, int block);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun static int sm_recheck_media(struct sm_ftl *ftl);
88