[deliverable/linux.git] / include / linux / mtd / mtd.h

/*
 * 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>
#include <linux/notifier.h>

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

#define MTD_CHAR_MAJOR 90
#define MTD_BLOCK_MAJOR 31
#define MAX_MTD_DEVICES 32

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

/* If the erase fails, fail_addr might indicate exactly which block failed.  If
   fail_addr = 0xffffffff, the failure was not at the device level or was not
   specific to any particular block. */
struct erase_info {
	struct mtd_info *mtd;
	u_int32_t addr;
	u_int32_t len;
	u_int32_t fail_addr;
	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 {
	u_int32_t offset;			/* At which this region starts, from the beginning of the MTD */
	u_int32_t erasesize;		/* For this region */
	u_int32_t numblocks;		/* Number of blocks of erasesize in this region */
	unsigned long *lockmap;		/* If keeping bitmap of locks */
};

/*
 * 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
 *
 * @len:	number of data bytes to write/read
 *
 * @retlen:	number of data bytes written/read
 *
 * @ooblen:	number of oob bytes to write/read
 * @oobretlen:	number of oob bytes written/read
 * @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
 *
 * 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.
 */
struct mtd_oob_ops {
	mtd_oob_mode_t	mode;
	size_t		len;
	size_t		retlen;
	size_t		ooblen;
	size_t		oobretlen;
	uint32_t	ooboffs;
	uint8_t		*datbuf;
	uint8_t		*oobbuf;
};

struct mtd_info {
	u_char type;
	u_int32_t flags;
	u_int32_t size;	 // Total size of the MTD

	/* "Major" erase size for the device. Naïve users may take this
	 * to be the only erase size available, or may use the more detailed
	 * information below if they desire
	 */
	u_int32_t erasesize;
	/* 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.
	 */
	u_int32_t writesize;

	u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
	u_int32_t oobavail;  // Available OOB bytes per block

	// Kernel-only stuff starts here.
	const char *name;
	int index;

	/* ecc layout structure pointer - read only ! */
	struct nand_ecclayout *ecclayout;

	/* Data for variable erase regions. If numeraseregions is zero,
	 * it means that the whole device has erasesize as given above.
	 */
	int numeraseregions;
	struct mtd_erase_region_info *eraseregions;

	/*
	 * 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.
	 */
	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);

	/* This stuff for eXecute-In-Place */
	/* 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);

	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
	void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);


	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);

	/* 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);

	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);

	/*
	 * Methods to access the protection register area, present in some
	 * flash devices. The user data is one time programmable but the
	 * factory data is read only.
	 */
	int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
	int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	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);
	int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
	int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);

	/* kvec-based read/write methods.
	   NB: The 'count' parameter is the number of _vectors_, each of
	   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 */
	int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
	int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);

	/* 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);

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

	/* ECC status information */
	struct mtd_ecc_stats ecc_stats;
	/* Subpage shift (NAND) */
	int subpage_sft;

	void *priv;

	struct module *owner;
	int usecount;

	/* 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);
};


	/* 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);
extern struct mtd_info *get_mtd_device_nm(const char *name);

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...)				\
	do {						\
		if (n <= CONFIG_MTD_DEBUG_VERBOSE)	\
			printk(KERN_INFO args);		\
	} while(0)
#else /* CONFIG_MTD_DEBUG */
#define DEBUG(n, args...)				\
	do {						\
		if (0)					\
			printk(KERN_INFO args);		\
	} while(0)

#endif /* CONFIG_MTD_DEBUG */

#endif /* __MTD_MTD_H__ */
Commit	Line	Data
61ecfa87	1	/*
1da177e4 LT	2	* Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
	3	*
	4	* Released under GPL
	5	*/
	6
	7	#ifndef __MTD_MTD_H__
	8	#define __MTD_MTD_H__
	9
1da177e4 LT	10	#include <linux/types.h>
	11	#include <linux/module.h>
	12	#include <linux/uio.h>
963a6fb0	13	#include <linux/notifier.h>
1da177e4 LT	14
	15	#include <linux/mtd/compatmac.h>
	16	#include <mtd/mtd-abi.h>
	17
	18	#define MTD_CHAR_MAJOR 90
	19	#define MTD_BLOCK_MAJOR 31
c0fe10ae	20	#define MAX_MTD_DEVICES 32
1da177e4 LT	21
	22	#define MTD_ERASE_PENDING 0x01
	23	#define MTD_ERASING 0x02
	24	#define MTD_ERASE_SUSPEND 0x04
	25	#define MTD_ERASE_DONE 0x08
	26	#define MTD_ERASE_FAILED 0x10
	27
	28	/* If the erase fails, fail_addr might indicate exactly which block failed. If
	29	fail_addr = 0xffffffff, the failure was not at the device level or was not
	30	specific to any particular block. */
	31	struct erase_info {
	32	struct mtd_info *mtd;
	33	u_int32_t addr;
	34	u_int32_t len;
	35	u_int32_t fail_addr;
	36	u_long time;
	37	u_long retries;
	38	u_int dev;
	39	u_int cell;
	40	void (callback) (struct erase_info self);
	41	u_long priv;
	42	u_char state;
	43	struct erase_info *next;
	44	};
	45
	46	struct mtd_erase_region_info {
	47	u_int32_t offset; /* At which this region starts, from the beginning of the MTD */
	48	u_int32_t erasesize; /* For this region */
	49	u_int32_t numblocks; /* Number of blocks of erasesize in this region */
0ecbc81a	50	unsigned long lockmap; / If keeping bitmap of locks */
1da177e4 LT	51	};
1da177e4 LT	52
8593fbc6 TG	53	/*
	54	* oob operation modes
	55	*
	56	* MTD_OOB_PLACE: oob data are placed at the given offset
	57	* MTD_OOB_AUTO: oob data are automatically placed at the free areas
	58	* which are defined by the ecclayout
	59	* MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data
	60	* is inserted into the data. Thats a raw image of the
	61	* flash contents.
	62	*/
	63	typedef enum {
	64	MTD_OOB_PLACE,
	65	MTD_OOB_AUTO,
	66	MTD_OOB_RAW,
	67	} mtd_oob_mode_t;
	68
	69	/**
	70	* struct mtd_oob_ops - oob operation operands
	71	* @mode: operation mode
	72	*
7014568b	73	* @len: number of data bytes to write/read
8593fbc6	74	*
7014568b	75	* @retlen: number of data bytes written/read
8593fbc6	76	*
7014568b VW	77	* @ooblen: number of oob bytes to write/read
7014568b VW	78	* @oobretlen: number of oob bytes written/read
8593fbc6 TG	79	* @ooboffs: offset of oob data in the oob area (only relevant when
	80	* mode = MTD_OOB_PLACE)
	81	* @datbuf: data buffer - if NULL only oob data are read/written
	82	* @oobbuf: oob data buffer
73a4421c AB	83	*
	84	* Note, it is allowed to read more then one OOB area at one go, but not write.
	85	* The interface assumes that the OOB write requests program only one page's
	86	* OOB area.
8593fbc6 TG	87	*/
	88	struct mtd_oob_ops {
	89	mtd_oob_mode_t mode;
	90	size_t len;
	91	size_t retlen;
	92	size_t ooblen;
7014568b	93	size_t oobretlen;
8593fbc6 TG	94	uint32_t ooboffs;
	95	uint8_t *datbuf;
	96	uint8_t *oobbuf;
	97	};
	98
1da177e4 LT	99	struct mtd_info {
	100	u_char type;
	101	u_int32_t flags;
	102	u_int32_t size; // Total size of the MTD
	103
151e7659	104	/* "Major" erase size for the device. Naïve users may take this
1da177e4 LT	105	* to be the only erase size available, or may use the more detailed
	106	* information below if they desire
	107	*/
	108	u_int32_t erasesize;
783ed81f AB	109	/* Minimal writable flash unit size. In case of NOR flash it is 1 (even
	110	* though individual bits can be cleared), in case of NAND flash it is
	111	* one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
	112	* it is of ECC block size, etc. It is illegal to have writesize = 0.
	113	* Any driver registering a struct mtd_info must ensure a writesize of
	114	* 1 or larger.
28318776 JE	115	*/
28318776 JE	116	u_int32_t writesize;
1da177e4	117
1da177e4	118	u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
1f92267c	119	u_int32_t oobavail; // Available OOB bytes per block
638d9838	120
1da177e4	121	// Kernel-only stuff starts here.
eadcf0d7	122	const char *name;
1da177e4 LT	123	int index;
1da177e4 LT	124
5bd34c09 TG	125	/* ecc layout structure pointer - read only ! */
5bd34c09 TG	126	struct nand_ecclayout *ecclayout;
1da177e4 LT	127
1da177e4 LT	128	/* Data for variable erase regions. If numeraseregions is zero,
61ecfa87	129	* it means that the whole device has erasesize as given above.
1da177e4 LT	130	*/
1da177e4 LT	131	int numeraseregions;
61ecfa87	132	struct mtd_erase_region_info *eraseregions;
1da177e4	133
b38178ee JE	134	/*
	135	* Erase is an asynchronous operation. Device drivers are supposed
	136	* to call instr->callback() whenever the operation completes, even
	137	* if it completes with a failure.
	138	* Callers are supposed to pass a callback function and wait for it
	139	* to be called before writing to the block.
	140	*/
1da177e4 LT	141	int (erase) (struct mtd_info mtd, struct erase_info *instr);
	142
	143	/* This stuff for eXecute-In-Place */
a98889f3 JH	144	/* phys is optional and may be set to NULL */
	145	int (point) (struct mtd_info mtd, loff_t from, size_t len,
	146	size_t retlen, void virt, resource_size_t phys);
1da177e4 LT	147
1da177e4 LT	148	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
a98889f3	149	void (unpoint) (struct mtd_info mtd, loff_t from, size_t len);
1da177e4 LT	150
	151
	152	int (read) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
	153	int (write) (struct mtd_info mtd, loff_t to, size_t len, size_t retlen, const u_char buf);
	154
388bbb09 RP	155	/* In blackbox flight recorder like scenarios we want to make successful
	156	writes in interrupt context. panic_write() is only intended to be
	157	called when its known the kernel is about to panic and we need the
	158	write to succeed. Since the kernel is not going to be running for much
	159	longer, this function can break locks and delay to ensure the write
	160	succeeds (but not sleep). */
	161
	162	int (panic_write) (struct mtd_info mtd, loff_t to, size_t len, size_t retlen, const u_char buf);
	163
8593fbc6 TG	164	int (read_oob) (struct mtd_info mtd, loff_t from,
	165	struct mtd_oob_ops *ops);
	166	int (write_oob) (struct mtd_info mtd, loff_t to,
	167	struct mtd_oob_ops *ops);
1da177e4	168
61ecfa87 TG	169	/*
61ecfa87 TG	170	* Methods to access the protection register area, present in some
1da177e4	171	* flash devices. The user data is one time programmable but the
61ecfa87	172	* factory data is read only.
1da177e4	173	*/
f77814dd	174	int (get_fact_prot_info) (struct mtd_info mtd, struct otp_info *buf, size_t len);
1da177e4	175	int (read_fact_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
f77814dd NP	176	int (get_user_prot_info) (struct mtd_info mtd, struct otp_info *buf, size_t len);
f77814dd NP	177	int (read_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
1da177e4	178	int (write_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
f77814dd	179	int (lock_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len);
1da177e4	180
2528e8cd	181	/* kvec-based read/write methods.
61ecfa87	182	NB: The 'count' parameter is the number of _vectors_, each of
1da177e4 LT	183	which contains an (ofs, len) tuple.
1da177e4 LT	184	*/
1da177e4	185	int (writev) (struct mtd_info mtd, const struct kvec vecs, unsigned long count, loff_t to, size_t retlen);
1da177e4 LT	186
	187	/* Sync */
	188	void (sync) (struct mtd_info mtd);
	189
	190	/* Chip-supported device locking */
	191	int (lock) (struct mtd_info mtd, loff_t ofs, size_t len);
	192	int (unlock) (struct mtd_info mtd, loff_t ofs, size_t len);
	193
	194	/* Power Management functions */
	195	int (suspend) (struct mtd_info mtd);
	196	void (resume) (struct mtd_info mtd);
	197
	198	/* Bad block management functions */
	199	int (block_isbad) (struct mtd_info mtd, loff_t ofs);
	200	int (block_markbad) (struct mtd_info mtd, loff_t ofs);
	201
963a6fb0 NP	202	struct notifier_block reboot_notifier; /* default mode before reboot */
963a6fb0 NP	203
7fac4648 TG	204	/* ECC status information */
7fac4648 TG	205	struct mtd_ecc_stats ecc_stats;
29072b96 TG	206	/* Subpage shift (NAND) */
29072b96 TG	207	int subpage_sft;
7fac4648	208
1da177e4 LT	209	void *priv;
	210
	211	struct module *owner;
	212	int usecount;
9fe912ce AB	213
	214	/* If the driver is something smart, like UBI, it may need to maintain
	215	* its own reference counting. The below functions are only for driver.
	216	* The driver may register its callbacks. These callbacks are not
	217	* supposed to be called by MTD users */
	218	int (get_device) (struct mtd_info mtd);
	219	void (put_device) (struct mtd_info mtd);
1da177e4 LT	220	};
	221
	222
	223	/* Kernel-side ioctl definitions */
	224
	225	extern int add_mtd_device(struct mtd_info *mtd);
	226	extern int del_mtd_device (struct mtd_info *mtd);
	227
	228	extern struct mtd_info get_mtd_device(struct mtd_info mtd, int num);
7799308f	229	extern struct mtd_info get_mtd_device_nm(const char name);
1da177e4 LT	230
	231	extern void put_mtd_device(struct mtd_info *mtd);
	232
	233
	234	struct mtd_notifier {
	235	void (add)(struct mtd_info mtd);
	236	void (remove)(struct mtd_info mtd);
	237	struct list_head list;
	238	};
	239
	240
	241	extern void register_mtd_user (struct mtd_notifier *new);
	242	extern int unregister_mtd_user (struct mtd_notifier *old);
	243
	244	int default_mtd_writev(struct mtd_info mtd, const struct kvec vecs,
	245	unsigned long count, loff_t to, size_t *retlen);
	246
	247	int default_mtd_readv(struct mtd_info mtd, struct kvec vecs,
	248	unsigned long count, loff_t from, size_t *retlen);
	249
1da177e4 LT	250	#ifdef CONFIG_MTD_PARTITIONS
	251	void mtd_erase_callback(struct erase_info *instr);
	252	#else
	253	static inline void mtd_erase_callback(struct erase_info *instr)
	254	{
	255	if (instr->callback)
	256	instr->callback(instr);
	257	}
	258	#endif
	259
	260	/*
	261	* Debugging macro and defines
	262	*/
	263	#define MTD_DEBUG_LEVEL0 (0) /* Quiet */
	264	#define MTD_DEBUG_LEVEL1 (1) /* Audible */
	265	#define MTD_DEBUG_LEVEL2 (2) /* Loud */
	266	#define MTD_DEBUG_LEVEL3 (3) /* Noisy */
	267
	268	#ifdef CONFIG_MTD_DEBUG
	269	#define DEBUG(n, args...) \
f4a43cfc	270	do { \
1da177e4 LT	271	if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
	272	printk(KERN_INFO args); \
	273	} while(0)
	274	#else /* CONFIG_MTD_DEBUG */
95b1bc20 DB	275	#define DEBUG(n, args...) \
	276	do { \
	277	if (0) \
	278	printk(KERN_INFO args); \
	279	} while(0)
1da177e4 LT	280
	281	#endif /* CONFIG_MTD_DEBUG */
	282
	283	#endif /* __MTD_MTD_H__ */