[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/device.h>

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

#include <asm/div64.h>

#define MTD_CHAR_MAJOR 90
#define MTD_BLOCK_MAJOR 31

#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 -1LL

/* 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;
	uint64_t addr;
	uint64_t len;
	uint64_t fail_addr;
	u_long time;
	u_long retries;
	unsigned dev;
	unsigned cell;
	void (*callback) (struct erase_info *self);
	u_long priv;
	u_char state;
	struct erase_info *next;
};

struct mtd_erase_region_info {
	uint64_t offset;			/* At which this region starts, from the beginning of the MTD */
	uint32_t erasesize;		/* For this region */
	uint32_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;
	uint32_t flags;
	uint64_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
	 */
	uint32_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.
	 */
	uint32_t writesize;

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

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

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

	/* Allow NOMMU mmap() to directly map the device (if not NULL)
	 * - return the address to which the offset maps
	 * - return -ENOSYS to indicate refusal to do the mapping
	 */
	unsigned long (*get_unmapped_area) (struct mtd_info *mtd,
					    unsigned long len,
					    unsigned long offset,
					    unsigned long flags);

	/* Backing device capabilities for this device
	 * - provides mmap capabilities
	 */
	struct backing_dev_info *backing_dev_info;


	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, uint64_t len);
	int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_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;
	struct device dev;
	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);
};

static inline struct mtd_info *dev_to_mtd(struct device *dev)
{
	return dev ? dev_get_drvdata(dev) : NULL;
}

static inline uint32_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 uint32_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 uint32_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 uint32_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);
}

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