[net-next-2.6.git] / include / linux / mtd / mtd.h

/*
 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#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 <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 oob and data without doing ECC checking
 */
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;
};

#define MTD_MAX_OOBFREE_ENTRIES_LARGE	32
#define MTD_MAX_ECCPOS_ENTRIES_LARGE	448
/*
 * Internal ECC layout control structure. For historical reasons, there is a
 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
 * for export to user-space via the ECCGETLAYOUT ioctl.
 * nand_ecclayout should be expandable in the future simply by the above macros.
 */
struct nand_ecclayout {
	__u32 eccbytes;
	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
	__u32 oobavail;
	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
};

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