mtd.h 9.8 KB
Newer Older
1
/*
L
Linus Torvalds 已提交
2 3 4 5 6 7 8 9 10 11 12
 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
 *
 * Released under GPL
 */

#ifndef __MTD_MTD_H__
#define __MTD_MTD_H__

#include <linux/types.h>
#include <linux/module.h>
#include <linux/uio.h>
13
#include <linux/notifier.h>
L
Linus Torvalds 已提交
14 15 16 17

#include <linux/mtd/compatmac.h>
#include <mtd/mtd-abi.h>

18 19
#include <asm/div64.h>

L
Linus Torvalds 已提交
20 21
#define MTD_CHAR_MAJOR 90
#define MTD_BLOCK_MAJOR 31
A
Artem Bityutskiy 已提交
22
#define MAX_MTD_DEVICES 32
L
Linus Torvalds 已提交
23 24 25 26 27 28 29

#define MTD_ERASE_PENDING      	0x01
#define MTD_ERASING		0x02
#define MTD_ERASE_SUSPEND	0x04
#define MTD_ERASE_DONE          0x08
#define MTD_ERASE_FAILED        0x10

30
#define MTD_FAIL_ADDR_UNKNOWN -1LL
31

L
Linus Torvalds 已提交
32
/* If the erase fails, fail_addr might indicate exactly which block failed.  If
33
   fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
L
Linus Torvalds 已提交
34 35 36
   specific to any particular block. */
struct erase_info {
	struct mtd_info *mtd;
37 38 39
	uint64_t addr;
	uint64_t len;
	uint64_t fail_addr;
L
Linus Torvalds 已提交
40 41 42 43 44 45 46 47 48 49 50
	u_long time;
	u_long retries;
	u_int dev;
	u_int cell;
	void (*callback) (struct erase_info *self);
	u_long priv;
	u_char state;
	struct erase_info *next;
};

struct mtd_erase_region_info {
51
	uint64_t offset;			/* At which this region starts, from the beginning of the MTD */
L
Linus Torvalds 已提交
52 53
	u_int32_t erasesize;		/* For this region */
	u_int32_t numblocks;		/* Number of blocks of erasesize in this region */
54
	unsigned long *lockmap;		/* If keeping bitmap of locks */
L
Linus Torvalds 已提交
55 56
};

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/*
 * oob operation modes
 *
 * MTD_OOB_PLACE:	oob data are placed at the given offset
 * MTD_OOB_AUTO:	oob data are automatically placed at the free areas
 *			which are defined by the ecclayout
 * MTD_OOB_RAW:		mode to read raw data+oob in one chunk. The oob data
 *			is inserted into the data. Thats a raw image of the
 *			flash contents.
 */
typedef enum {
	MTD_OOB_PLACE,
	MTD_OOB_AUTO,
	MTD_OOB_RAW,
} mtd_oob_mode_t;

/**
 * struct mtd_oob_ops - oob operation operands
 * @mode:	operation mode
 *
77
 * @len:	number of data bytes to write/read
78
 *
79
 * @retlen:	number of data bytes written/read
80
 *
81 82
 * @ooblen:	number of oob bytes to write/read
 * @oobretlen:	number of oob bytes written/read
83 84 85 86
 * @ooboffs:	offset of oob data in the oob area (only relevant when
 *		mode = MTD_OOB_PLACE)
 * @datbuf:	data buffer - if NULL only oob data are read/written
 * @oobbuf:	oob data buffer
87 88 89 90
 *
 * Note, it is allowed to read more then one OOB area at one go, but not write.
 * The interface assumes that the OOB write requests program only one page's
 * OOB area.
91 92 93 94 95 96
 */
struct mtd_oob_ops {
	mtd_oob_mode_t	mode;
	size_t		len;
	size_t		retlen;
	size_t		ooblen;
97
	size_t		oobretlen;
98 99 100 101 102
	uint32_t	ooboffs;
	uint8_t		*datbuf;
	uint8_t		*oobbuf;
};

L
Linus Torvalds 已提交
103 104 105
struct mtd_info {
	u_char type;
	u_int32_t flags;
106
	uint64_t size;	 // Total size of the MTD
L
Linus Torvalds 已提交
107

108
	/* "Major" erase size for the device. Naïve users may take this
L
Linus Torvalds 已提交
109 110 111 112
	 * to be the only erase size available, or may use the more detailed
	 * information below if they desire
	 */
	u_int32_t erasesize;
113 114 115 116 117 118
	/* Minimal writable flash unit size. In case of NOR flash it is 1 (even
	 * though individual bits can be cleared), in case of NAND flash it is
	 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
	 * it is of ECC block size, etc. It is illegal to have writesize = 0.
	 * Any driver registering a struct mtd_info must ensure a writesize of
	 * 1 or larger.
J
Joern Engel 已提交
119 120
	 */
	u_int32_t writesize;
L
Linus Torvalds 已提交
121 122

	u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
V
Vitaly Wool 已提交
123
	u_int32_t oobavail;  // Available OOB bytes per block
124

125 126 127 128 129 130 131 132 133 134
	/*
	 * If erasesize is a power of 2 then the shift is stored in
	 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
	 */
	unsigned int erasesize_shift;
	unsigned int writesize_shift;
	/* Masks based on erasesize_shift and writesize_shift */
	unsigned int erasesize_mask;
	unsigned int writesize_mask;

L
Linus Torvalds 已提交
135
	// Kernel-only stuff starts here.
136
	const char *name;
L
Linus Torvalds 已提交
137 138
	int index;

139 140
	/* ecc layout structure pointer - read only ! */
	struct nand_ecclayout *ecclayout;
L
Linus Torvalds 已提交
141 142

	/* Data for variable erase regions. If numeraseregions is zero,
143
	 * it means that the whole device has erasesize as given above.
L
Linus Torvalds 已提交
144 145
	 */
	int numeraseregions;
146
	struct mtd_erase_region_info *eraseregions;
L
Linus Torvalds 已提交
147

J
Jörn Engel 已提交
148 149 150 151 152 153 154
	/*
	 * Erase is an asynchronous operation.  Device drivers are supposed
	 * to call instr->callback() whenever the operation completes, even
	 * if it completes with a failure.
	 * Callers are supposed to pass a callback function and wait for it
	 * to be called before writing to the block.
	 */
L
Linus Torvalds 已提交
155 156 157
	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);

	/* This stuff for eXecute-In-Place */
158 159 160
	/* phys is optional and may be set to NULL */
	int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
			size_t *retlen, void **virt, resource_size_t *phys);
L
Linus Torvalds 已提交
161 162

	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
163
	void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
L
Linus Torvalds 已提交
164 165 166 167 168


	int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);

169 170 171 172 173 174 175 176 177
	/* In blackbox flight recorder like scenarios we want to make successful
	   writes in interrupt context. panic_write() is only intended to be
	   called when its known the kernel is about to panic and we need the
	   write to succeed. Since the kernel is not going to be running for much
	   longer, this function can break locks and delay to ensure the write
	   succeeds (but not sleep). */

	int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);

178 179 180 181
	int (*read_oob) (struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops);
	int (*write_oob) (struct mtd_info *mtd, loff_t to,
			 struct mtd_oob_ops *ops);
L
Linus Torvalds 已提交
182

183 184
	/*
	 * Methods to access the protection register area, present in some
L
Linus Torvalds 已提交
185
	 * flash devices. The user data is one time programmable but the
186
	 * factory data is read only.
L
Linus Torvalds 已提交
187
	 */
188
	int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
L
Linus Torvalds 已提交
189
	int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
190 191
	int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
	int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
L
Linus Torvalds 已提交
192
	int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
193
	int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
L
Linus Torvalds 已提交
194

T
Thomas Gleixner 已提交
195
	/* kvec-based read/write methods.
196
	   NB: The 'count' parameter is the number of _vectors_, each of
L
Linus Torvalds 已提交
197 198 199 200 201 202 203 204
	   which contains an (ofs, len) tuple.
	*/
	int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);

	/* Sync */
	void (*sync) (struct mtd_info *mtd);

	/* Chip-supported device locking */
205 206
	int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
	int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
L
Linus Torvalds 已提交
207 208 209 210 211 212 213 214 215

	/* Power Management functions */
	int (*suspend) (struct mtd_info *mtd);
	void (*resume) (struct mtd_info *mtd);

	/* Bad block management functions */
	int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
	int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);

216 217
	struct notifier_block reboot_notifier;  /* default mode before reboot */

218 219
	/* ECC status information */
	struct mtd_ecc_stats ecc_stats;
220 221
	/* Subpage shift (NAND) */
	int subpage_sft;
222

L
Linus Torvalds 已提交
223 224 225 226
	void *priv;

	struct module *owner;
	int usecount;
A
Artem Bityutskiy 已提交
227 228 229 230 231 232 233

	/* If the driver is something smart, like UBI, it may need to maintain
	 * its own reference counting. The below functions are only for driver.
	 * The driver may register its callbacks. These callbacks are not
	 * supposed to be called by MTD users */
	int (*get_device) (struct mtd_info *mtd);
	void (*put_device) (struct mtd_info *mtd);
L
Linus Torvalds 已提交
234 235
};

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
static inline u_int32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
{
	if (mtd->erasesize_shift)
		return sz >> mtd->erasesize_shift;
	do_div(sz, mtd->erasesize);
	return sz;
}

static inline u_int32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
{
	if (mtd->erasesize_shift)
		return sz & mtd->erasesize_mask;
	return do_div(sz, mtd->erasesize);
}

static inline u_int32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
{
	if (mtd->writesize_shift)
		return sz >> mtd->writesize_shift;
	do_div(sz, mtd->writesize);
	return sz;
}

static inline u_int32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
{
	if (mtd->writesize_shift)
		return sz & mtd->writesize_mask;
	return do_div(sz, mtd->writesize);
}
L
Linus Torvalds 已提交
265 266 267 268 269 270 271

	/* Kernel-side ioctl definitions */

extern int add_mtd_device(struct mtd_info *mtd);
extern int del_mtd_device (struct mtd_info *mtd);

extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
272
extern struct mtd_info *get_mtd_device_nm(const char *name);
L
Linus Torvalds 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

extern void put_mtd_device(struct mtd_info *mtd);


struct mtd_notifier {
	void (*add)(struct mtd_info *mtd);
	void (*remove)(struct mtd_info *mtd);
	struct list_head list;
};


extern void register_mtd_user (struct mtd_notifier *new);
extern int unregister_mtd_user (struct mtd_notifier *old);

int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
		       unsigned long count, loff_t to, size_t *retlen);

int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
		      unsigned long count, loff_t from, size_t *retlen);

#ifdef CONFIG_MTD_PARTITIONS
void mtd_erase_callback(struct erase_info *instr);
#else
static inline void mtd_erase_callback(struct erase_info *instr)
{
	if (instr->callback)
		instr->callback(instr);
}
#endif

/*
 * Debugging macro and defines
 */
#define MTD_DEBUG_LEVEL0	(0)	/* Quiet   */
#define MTD_DEBUG_LEVEL1	(1)	/* Audible */
#define MTD_DEBUG_LEVEL2	(2)	/* Loud    */
#define MTD_DEBUG_LEVEL3	(3)	/* Noisy   */

#ifdef CONFIG_MTD_DEBUG
#define DEBUG(n, args...)				\
313
	do {						\
L
Linus Torvalds 已提交
314 315 316 317
		if (n <= CONFIG_MTD_DEBUG_VERBOSE)	\
			printk(KERN_INFO args);		\
	} while(0)
#else /* CONFIG_MTD_DEBUG */
318 319 320 321 322
#define DEBUG(n, args...)				\
	do {						\
		if (0)					\
			printk(KERN_INFO args);		\
	} while(0)
L
Linus Torvalds 已提交
323 324 325 326

#endif /* CONFIG_MTD_DEBUG */

#endif /* __MTD_MTD_H__ */