[linux-block.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

#define MTD_FAIL_ADDR_UNKNOWN 0xffffffff

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