[deliverable/linux.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;

	/*
	 * Size of the write buffer used by the MTD. MTD devices having a write
	 * buffer can write multiple writesize chunks at a time. E.g. while
	 * writing 4 * writesize bytes to a device with 2 * writesize bytes
	 * buffer the MTD driver can (but doesn't have to) do 2 writesize
	 * operations, but not 4. Currently, all NANDs have writebufsize
	 * equivalent to writesize (NAND page size). Some NOR flashes do have
	 * writebufsize greater than writesize.
	 */
	uint32_t writebufsize;

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

struct mtd_partition;
struct mtd_part_parser_data;

extern int mtd_device_parse_register(struct mtd_info *mtd,
			      const char **part_probe_types,
			      struct mtd_part_parser_data *parser_data,
			      const struct mtd_partition *defparts,
			      int defnr_parts);
#define mtd_device_register(master, parts, nr_parts)	\
	mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
extern int mtd_device_unregister(struct mtd_info *master);
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);

void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);

void mtd_erase_callback(struct erase_info *instr);

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