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

/*
 * $Id: mtd.h,v 1.61 2005/11/07 11:14:54 gleixner Exp $
 *
 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
 *
 * Released under GPL
 */

#ifndef __MTD_MTD_H__
#define __MTD_MTD_H__

#ifndef __KERNEL__
#error This is a kernel header. Perhaps include mtd-user.h instead?
#endif

#include <linux/config.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 16

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

/**
 * struct mtd_ecc_stats - error correction status
 *
 * @corrected:	number of corrected bits
 * @failed:	number of uncorrectable errors
 */
struct mtd_ecc_stats {
	unsigned long corrected;
	unsigned long failed;
};

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;
	/* Smallest availlable size for writing to the device.  For NAND,
	 * this is the page size, for some NOR chips, the size of ECC
	 * covered blocks.
	 */
	u_int32_t writesize;

	u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
	u_int32_t ecctype;
	u_int32_t eccsize;

	/*
	 * Reuse some of the above unused fields in the case of NOR flash
	 * with configurable programming regions to avoid modifying the
	 * user visible structure layout/size.  Only valid when the
	 * MTD_PROGRAM_REGIONS flag is set.
	 * (Maybe we should have an union for those?)
	 */
#define MTD_PROGREGION_CTRLMODE_VALID(mtd)  (mtd)->oobsize
#define MTD_PROGREGION_CTRLMODE_INVALID(mtd)  (mtd)->ecctype

	// Kernel-only stuff starts here.
	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;

	/* This really shouldn't be here. It can go away in 2.5 */
	u_int32_t bank_size;

	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);

	/* This stuff for eXecute-In-Place */
	int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);

	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
	void (*unpoint) (struct mtd_info *mtd, u_char * addr, 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);

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

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

	void *priv;

	struct module *owner;
	int usecount;
};


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

#define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
#define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
#define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
#define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
#define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
#define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
#define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
#define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
#define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
#define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
#define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
#define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd);  } while (0)


#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 { } while(0)

#endif /* CONFIG_MTD_DEBUG */

#endif /* __MTD_MTD_H__ */
Commit	Line	Data
61ecfa87 TG	1	/*
61ecfa87 TG	2	* $Id: mtd.h,v 1.61 2005/11/07 11:14:54 gleixner Exp $
1da177e4 LT	3	*
	4	* Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
	5	*
	6	* Released under GPL
	7	*/
	8
	9	#ifndef __MTD_MTD_H__
	10	#define __MTD_MTD_H__
	11
	12	#ifndef __KERNEL__
	13	#error This is a kernel header. Perhaps include mtd-user.h instead?
	14	#endif
	15
	16	#include <linux/config.h>
1da177e4 LT	17	#include <linux/types.h>
	18	#include <linux/module.h>
	19	#include <linux/uio.h>
963a6fb0	20	#include <linux/notifier.h>
1da177e4 LT	21
	22	#include <linux/mtd/compatmac.h>
	23	#include <mtd/mtd-abi.h>
	24
	25	#define MTD_CHAR_MAJOR 90
	26	#define MTD_BLOCK_MAJOR 31
	27	#define MAX_MTD_DEVICES 16
	28
	29	#define MTD_ERASE_PENDING 0x01
	30	#define MTD_ERASING 0x02
	31	#define MTD_ERASE_SUSPEND 0x04
	32	#define MTD_ERASE_DONE 0x08
	33	#define MTD_ERASE_FAILED 0x10
	34
	35	/* If the erase fails, fail_addr might indicate exactly which block failed. If
	36	fail_addr = 0xffffffff, the failure was not at the device level or was not
	37	specific to any particular block. */
	38	struct erase_info {
	39	struct mtd_info *mtd;
	40	u_int32_t addr;
	41	u_int32_t len;
	42	u_int32_t fail_addr;
	43	u_long time;
	44	u_long retries;
	45	u_int dev;
	46	u_int cell;
	47	void (callback) (struct erase_info self);
	48	u_long priv;
	49	u_char state;
	50	struct erase_info *next;
	51	};
	52
	53	struct mtd_erase_region_info {
	54	u_int32_t offset; /* At which this region starts, from the beginning of the MTD */
	55	u_int32_t erasesize; /* For this region */
	56	u_int32_t numblocks; /* Number of blocks of erasesize in this region */
	57	};
	58
7fac4648 TG	59	/**
	60	* struct mtd_ecc_stats - error correction status
	61	*
	62	* @corrected: number of corrected bits
	63	* @failed: number of uncorrectable errors
	64	*/
	65	struct mtd_ecc_stats {
	66	unsigned long corrected;
	67	unsigned long failed;
	68	};
	69
1da177e4 LT	70	struct mtd_info {
	71	u_char type;
	72	u_int32_t flags;
	73	u_int32_t size; // Total size of the MTD
	74
151e7659	75	/* "Major" erase size for the device. Naïve users may take this
1da177e4 LT	76	* to be the only erase size available, or may use the more detailed
	77	* information below if they desire
	78	*/
	79	u_int32_t erasesize;
28318776 JE	80	/* Smallest availlable size for writing to the device. For NAND,
	81	* this is the page size, for some NOR chips, the size of ECC
	82	* covered blocks.
	83	*/
	84	u_int32_t writesize;
1da177e4	85
1da177e4	86	u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
1da177e4 LT	87	u_int32_t ecctype;
1da177e4 LT	88	u_int32_t eccsize;
638d9838 NP	89
	90	/*
	91	* Reuse some of the above unused fields in the case of NOR flash
	92	* with configurable programming regions to avoid modifying the
	93	* user visible structure layout/size. Only valid when the
	94	* MTD_PROGRAM_REGIONS flag is set.
	95	* (Maybe we should have an union for those?)
	96	*/
638d9838 NP	97	#define MTD_PROGREGION_CTRLMODE_VALID(mtd) (mtd)->oobsize
638d9838 NP	98	#define MTD_PROGREGION_CTRLMODE_INVALID(mtd) (mtd)->ecctype
1da177e4 LT	99
	100	// Kernel-only stuff starts here.
	101	char *name;
	102	int index;
	103
5bd34c09 TG	104	/* ecc layout structure pointer - read only ! */
5bd34c09 TG	105	struct nand_ecclayout *ecclayout;
1da177e4 LT	106
1da177e4 LT	107	/* Data for variable erase regions. If numeraseregions is zero,
61ecfa87	108	* it means that the whole device has erasesize as given above.
1da177e4 LT	109	*/
1da177e4 LT	110	int numeraseregions;
61ecfa87	111	struct mtd_erase_region_info *eraseregions;
1da177e4 LT	112
	113	/* This really shouldn't be here. It can go away in 2.5 */
	114	u_int32_t bank_size;
	115
	116	int (erase) (struct mtd_info mtd, struct erase_info *instr);
	117
	118	/* This stuff for eXecute-In-Place */
	119	int (point) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char *mtdbuf);
	120
	121	/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
	122	void (unpoint) (struct mtd_info mtd, u_char * addr, loff_t from, size_t len);
	123
	124
	125	int (read) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
	126	int (write) (struct mtd_info mtd, loff_t to, size_t len, size_t retlen, const u_char buf);
	127
1da177e4 LT	128	int (read_oob) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
	129	int (write_oob) (struct mtd_info mtd, loff_t to, size_t len, size_t retlen, const u_char buf);
	130
61ecfa87 TG	131	/*
61ecfa87 TG	132	* Methods to access the protection register area, present in some
1da177e4	133	* flash devices. The user data is one time programmable but the
61ecfa87	134	* factory data is read only.
1da177e4	135	*/
f77814dd	136	int (get_fact_prot_info) (struct mtd_info mtd, struct otp_info *buf, size_t len);
1da177e4	137	int (read_fact_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
f77814dd NP	138	int (get_user_prot_info) (struct mtd_info mtd, struct otp_info *buf, size_t len);
f77814dd NP	139	int (read_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
1da177e4	140	int (write_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len, size_t retlen, u_char buf);
f77814dd	141	int (lock_user_prot_reg) (struct mtd_info mtd, loff_t from, size_t len);
1da177e4	142
2528e8cd	143	/* kvec-based read/write methods.
61ecfa87	144	NB: The 'count' parameter is the number of _vectors_, each of
1da177e4 LT	145	which contains an (ofs, len) tuple.
1da177e4 LT	146	*/
1da177e4	147	int (writev) (struct mtd_info mtd, const struct kvec vecs, unsigned long count, loff_t to, size_t retlen);
1da177e4 LT	148
	149	/* Sync */
	150	void (sync) (struct mtd_info mtd);
	151
	152	/* Chip-supported device locking */
	153	int (lock) (struct mtd_info mtd, loff_t ofs, size_t len);
	154	int (unlock) (struct mtd_info mtd, loff_t ofs, size_t len);
	155
	156	/* Power Management functions */
	157	int (suspend) (struct mtd_info mtd);
	158	void (resume) (struct mtd_info mtd);
	159
	160	/* Bad block management functions */
	161	int (block_isbad) (struct mtd_info mtd, loff_t ofs);
	162	int (block_markbad) (struct mtd_info mtd, loff_t ofs);
	163
963a6fb0 NP	164	struct notifier_block reboot_notifier; /* default mode before reboot */
963a6fb0 NP	165
7fac4648 TG	166	/* ECC status information */
	167	struct mtd_ecc_stats ecc_stats;
	168
1da177e4 LT	169	void *priv;
	170
	171	struct module *owner;
	172	int usecount;
	173	};
	174
	175
	176	/* Kernel-side ioctl definitions */
	177
	178	extern int add_mtd_device(struct mtd_info *mtd);
	179	extern int del_mtd_device (struct mtd_info *mtd);
	180
	181	extern struct mtd_info get_mtd_device(struct mtd_info mtd, int num);
	182
	183	extern void put_mtd_device(struct mtd_info *mtd);
	184
	185
	186	struct mtd_notifier {
	187	void (add)(struct mtd_info mtd);
	188	void (remove)(struct mtd_info mtd);
	189	struct list_head list;
	190	};
	191
	192
	193	extern void register_mtd_user (struct mtd_notifier *new);
	194	extern int unregister_mtd_user (struct mtd_notifier *old);
	195
	196	int default_mtd_writev(struct mtd_info mtd, const struct kvec vecs,
	197	unsigned long count, loff_t to, size_t *retlen);
	198
	199	int default_mtd_readv(struct mtd_info mtd, struct kvec vecs,
	200	unsigned long count, loff_t from, size_t *retlen);
	201
	202	#define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
	203	#define MTD_POINT(mtd, a,b,c,d) ((mtd->point))(mtd, a,b,c, (u_char *)(d))
	204	#define MTD_UNPOINT(mtd, arg) ((mtd->unpoint))(mtd, (u_char )arg)
	205	#define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
	206	#define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
	207	#define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
	208	#define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
	209	#define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
	210	#define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
	211	#define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
	212	#define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
61ecfa87	213	#define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0)
1da177e4 LT	214
	215
	216	#ifdef CONFIG_MTD_PARTITIONS
	217	void mtd_erase_callback(struct erase_info *instr);
	218	#else
	219	static inline void mtd_erase_callback(struct erase_info *instr)
	220	{
	221	if (instr->callback)
	222	instr->callback(instr);
	223	}
	224	#endif
	225
	226	/*
	227	* Debugging macro and defines
	228	*/
	229	#define MTD_DEBUG_LEVEL0 (0) /* Quiet */
	230	#define MTD_DEBUG_LEVEL1 (1) /* Audible */
	231	#define MTD_DEBUG_LEVEL2 (2) /* Loud */
	232	#define MTD_DEBUG_LEVEL3 (3) /* Noisy */
	233
	234	#ifdef CONFIG_MTD_DEBUG
	235	#define DEBUG(n, args...) \
	236	do { \
	237	if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
	238	printk(KERN_INFO args); \
	239	} while(0)
	240	#else /* CONFIG_MTD_DEBUG */
	241	#define DEBUG(n, args...) do { } while(0)
	242
	243	#endif /* CONFIG_MTD_DEBUG */
	244
	245	#endif /* __MTD_MTD_H__ */