[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/uio.h>
#include <linux/notifier.h>
#include <linux/device.h>

#include <mtd/mtd-abi.h>

#include <asm/div64.h>

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

/**
 * 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_OPS_PLACE_OOB or MTD_OPS_RAW)
 * @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 {
	unsigned int	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	640
/*
 * 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 module;	/* only needed for owner field in mtd_info */

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;

	/*
	 * read ops return -EUCLEAN if max number of bitflips corrected on any
	 * one region comprising an ecc step equals or exceeds this value.
	 * Settable by driver, else defaults to ecc_strength.  User can override
	 * in sysfs.  N.B. The meaning of the -EUCLEAN return code has changed;
	 * see Documentation/ABI/testing/sysfs-class-mtd for more detail.
	 */
	unsigned int bitflip_threshold;

	// Kernel-only stuff starts here.
	const char *name;
	int index;

	/* ECC layout structure pointer - read only! */
	struct nand_ecclayout *ecclayout;

	/* the ecc step size. */
	unsigned int ecc_step_size;

	/* max number of correctible bit errors per ecc step */
	unsigned int ecc_strength;

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

	/*
	 * Do not call via these pointers, use corresponding mtd_*()
	 * wrappers instead.
	 */
	int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
	int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
		       size_t *retlen, void **virt, resource_size_t *phys);
	int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
	unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
					     unsigned long len,
					     unsigned long offset,
					     unsigned long flags);
	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 (*_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);
	int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len,
				    size_t *retlen, struct otp_info *buf);
	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, size_t len,
				    size_t *retlen, struct otp_info *buf);
	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 to,
				     size_t len, size_t *retlen, u_char *buf);
	int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
				    size_t len);
	int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
			unsigned long count, loff_t to, size_t *retlen);
	void (*_sync) (struct mtd_info *mtd);
	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);
	int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs);
	int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
	int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
	int (*_suspend) (struct mtd_info *mtd);
	void (*_resume) (struct mtd_info *mtd);
	void (*_reboot) (struct mtd_info *mtd);
	/*
	 * If the driver is something smart, like UBI, it may need to maintain
	 * its own reference counting. The below functions are only for driver.
	 */
	int (*_get_device) (struct mtd_info *mtd);
	void (*_put_device) (struct mtd_info *mtd);

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

	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;
};

static inline void mtd_set_of_node(struct mtd_info *mtd,
				   struct device_node *np)
{
	mtd->dev.of_node = np;
}

static inline struct device_node *mtd_get_of_node(struct mtd_info *mtd)
{
	return mtd->dev.of_node;
}

int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
	      void **virt, resource_size_t *phys);
int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
				    unsigned long offset, unsigned long flags);
int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
	     u_char *buf);
int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
	      const u_char *buf);
int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
		    const u_char *buf);

int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);

static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
				struct mtd_oob_ops *ops)
{
	ops->retlen = ops->oobretlen = 0;
	if (!mtd->_write_oob)
		return -EOPNOTSUPP;
	if (!(mtd->flags & MTD_WRITEABLE))
		return -EROFS;
	return mtd->_write_oob(mtd, to, ops);
}

int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
			   struct otp_info *buf);
int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
			   size_t *retlen, u_char *buf);
int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
			   struct otp_info *buf);
int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
			   size_t *retlen, u_char *buf);
int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
			    size_t *retlen, u_char *buf);
int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);

int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
	       unsigned long count, loff_t to, size_t *retlen);

static inline void mtd_sync(struct mtd_info *mtd)
{
	if (mtd->_sync)
		mtd->_sync(mtd);
}

int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);

static inline int mtd_suspend(struct mtd_info *mtd)
{
	return mtd->_suspend ? mtd->_suspend(mtd) : 0;
}

static inline void mtd_resume(struct mtd_info *mtd)
{
	if (mtd->_resume)
		mtd->_resume(mtd);
}

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

static inline int mtd_has_oob(const struct mtd_info *mtd)
{
	return mtd->_read_oob && mtd->_write_oob;
}

static inline int mtd_type_is_nand(const struct mtd_info *mtd)
{
	return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
}

static inline int mtd_can_have_bb(const struct mtd_info *mtd)
{
	return !!mtd->_block_isbad;
}

	/* Kernel-side ioctl definitions */

struct mtd_partition;
struct mtd_part_parser_data;

extern int mtd_device_parse_register(struct mtd_info *mtd,
				     const char * const *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);
void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);

void mtd_erase_callback(struct erase_info *instr);

static inline int mtd_is_bitflip(int err) {
	return err == -EUCLEAN;
}

static inline int mtd_is_eccerr(int err) {
	return err == -EBADMSG;
}

static inline int mtd_is_bitflip_or_eccerr(int err) {
	return mtd_is_bitflip(err) || mtd_is_eccerr(err);
}

unsigned mtd_mmap_capabilities(struct mtd_info *mtd);

#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	23	#include <linux/types.h>
1da177e4	24	#include <linux/uio.h>
963a6fb0	25	#include <linux/notifier.h>
1f24b5a8	26	#include <linux/device.h>
1da177e4	27
1da177e4 LT	28	#include <mtd/mtd-abi.h>
1da177e4 LT	29
69423d99 AH	30	#include <asm/div64.h>
69423d99 AH	31
e2e24e8e	32	#define MTD_ERASE_PENDING 0x01
1da177e4 LT	33	#define MTD_ERASING 0x02
1da177e4 LT	34	#define MTD_ERASE_SUSPEND 0x04
e2e24e8e BN	35	#define MTD_ERASE_DONE 0x08
e2e24e8e BN	36	#define MTD_ERASE_FAILED 0x10
1da177e4	37
69423d99	38	#define MTD_FAIL_ADDR_UNKNOWN -1LL
bb0eb217	39
e2e24e8e BN	40	/*
	41	* If the erase fails, fail_addr might indicate exactly which block failed. If
	42	* fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level
	43	* or was not specific to any particular block.
	44	*/
1da177e4 LT	45	struct erase_info {
1da177e4 LT	46	struct mtd_info *mtd;
69423d99 AH	47	uint64_t addr;
	48	uint64_t len;
	49	uint64_t fail_addr;
1da177e4 LT	50	u_long time;
1da177e4 LT	51	u_long retries;
26cdb67c DW	52	unsigned dev;
26cdb67c DW	53	unsigned cell;
1da177e4 LT	54	void (callback) (struct erase_info self);
	55	u_long priv;
	56	u_char state;
	57	struct erase_info *next;
	58	};
	59
	60	struct mtd_erase_region_info {
e2e24e8e	61	uint64_t offset; /* At which this region starts, from the beginning of the MTD */
26cdb67c DW	62	uint32_t erasesize; /* For this region */
26cdb67c DW	63	uint32_t numblocks; /* Number of blocks of erasesize in this region */
0ecbc81a	64	unsigned long lockmap; / If keeping bitmap of locks */
1da177e4 LT	65	};
1da177e4 LT	66
8593fbc6 TG	67	/**
	68	* struct mtd_oob_ops - oob operation operands
	69	* @mode: operation mode
	70	*
7014568b	71	* @len: number of data bytes to write/read
8593fbc6	72	*
7014568b	73	* @retlen: number of data bytes written/read
8593fbc6	74	*
7014568b VW	75	* @ooblen: number of oob bytes to write/read
7014568b VW	76	* @oobretlen: number of oob bytes written/read
8593fbc6	77	* @ooboffs: offset of oob data in the oob area (only relevant when
4180f24a	78	* mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW)
8593fbc6 TG	79	* @datbuf: data buffer - if NULL only oob data are read/written
8593fbc6 TG	80	* @oobbuf: oob data buffer
73a4421c	81	*
025dfdaf	82	* Note, it is allowed to read more than one OOB area at one go, but not write.
73a4421c AB	83	* The interface assumes that the OOB write requests program only one page's
73a4421c AB	84	* OOB area.
8593fbc6 TG	85	*/
8593fbc6 TG	86	struct mtd_oob_ops {
905c6bcd	87	unsigned int mode;
8593fbc6 TG	88	size_t len;
	89	size_t retlen;
	90	size_t ooblen;
7014568b	91	size_t oobretlen;
8593fbc6 TG	92	uint32_t ooboffs;
	93	uint8_t *datbuf;
	94	uint8_t *oobbuf;
	95	};
	96
cc26c3cd	97	#define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
2f25ae97	98	#define MTD_MAX_ECCPOS_ENTRIES_LARGE 640
cc26c3cd	99	/*
0ceacf36 BN	100	* Internal ECC layout control structure. For historical reasons, there is a
	101	* similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
	102	* for export to user-space via the ECCGETLAYOUT ioctl.
	103	* nand_ecclayout should be expandable in the future simply by the above macros.
cc26c3cd BN	104	*/
	105	struct nand_ecclayout {
	106	__u32 eccbytes;
	107	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
	108	__u32 oobavail;
	109	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
	110	};
	111
de477254 PG	112	struct module; /* only needed for owner field in mtd_info */
de477254 PG	113
1da177e4 LT	114	struct mtd_info {
1da177e4 LT	115	u_char type;
26cdb67c	116	uint32_t flags;
69423d99	117	uint64_t size; // Total size of the MTD
1da177e4	118
151e7659	119	/* "Major" erase size for the device. Naïve users may take this
1da177e4 LT	120	* to be the only erase size available, or may use the more detailed
	121	* information below if they desire
	122	*/
26cdb67c	123	uint32_t erasesize;
783ed81f AB	124	/* Minimal writable flash unit size. In case of NOR flash it is 1 (even
	125	* though individual bits can be cleared), in case of NAND flash it is
	126	* one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
	127	* it is of ECC block size, etc. It is illegal to have writesize = 0.
	128	* Any driver registering a struct mtd_info must ensure a writesize of
	129	* 1 or larger.
28318776	130	*/
26cdb67c	131	uint32_t writesize;
1da177e4	132
0e4ca7e5 AG	133	/*
	134	* Size of the write buffer used by the MTD. MTD devices having a write
	135	* buffer can write multiple writesize chunks at a time. E.g. while
	136	* writing 4 * writesize bytes to a device with 2 * writesize bytes
	137	* buffer the MTD driver can (but doesn't have to) do 2 writesize
	138	* operations, but not 4. Currently, all NANDs have writebufsize
	139	* equivalent to writesize (NAND page size). Some NOR flashes do have
	140	* writebufsize greater than writesize.
	141	*/
	142	uint32_t writebufsize;
	143
26cdb67c DW	144	uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
26cdb67c DW	145	uint32_t oobavail; // Available OOB bytes per block
1da177e4	146
69423d99 AH	147	/*
	148	* If erasesize is a power of 2 then the shift is stored in
	149	* erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
	150	*/
	151	unsigned int erasesize_shift;
	152	unsigned int writesize_shift;
	153	/* Masks based on erasesize_shift and writesize_shift */
	154	unsigned int erasesize_mask;
	155	unsigned int writesize_mask;
638d9838	156
d062d4ed MD	157	/*
	158	* read ops return -EUCLEAN if max number of bitflips corrected on any
	159	* one region comprising an ecc step equals or exceeds this value.
	160	* Settable by driver, else defaults to ecc_strength. User can override
	161	* in sysfs. N.B. The meaning of the -EUCLEAN return code has changed;
	162	* see Documentation/ABI/testing/sysfs-class-mtd for more detail.
	163	*/
	164	unsigned int bitflip_threshold;
	165
1da177e4	166	// Kernel-only stuff starts here.
eadcf0d7	167	const char *name;
1da177e4 LT	168	int index;
1da177e4 LT	169
7854d3f7	170	/* ECC layout structure pointer - read only! */
5bd34c09	171	struct nand_ecclayout *ecclayout;
1da177e4	172
c41a0582 HS	173	/* the ecc step size. */
	174	unsigned int ecc_step_size;
	175
86c2072b	176	/* max number of correctible bit errors per ecc step */
1d0b95b0 MD	177	unsigned int ecc_strength;
1d0b95b0 MD	178
1da177e4	179	/* Data for variable erase regions. If numeraseregions is zero,
61ecfa87	180	* it means that the whole device has erasesize as given above.
1da177e4 LT	181	*/
1da177e4 LT	182	int numeraseregions;
61ecfa87	183	struct mtd_erase_region_info *eraseregions;
1da177e4	184
b38178ee	185	/*
7e1f0dc0 AB	186	* Do not call via these pointers, use corresponding mtd_*()
7e1f0dc0 AB	187	* wrappers instead.
b38178ee	188	*/
3c3c10bb AB	189	int (_erase) (struct mtd_info mtd, struct erase_info *instr);
	190	int (_point) (struct mtd_info mtd, loff_t from, size_t len,
	191	size_t retlen, void virt, resource_size_t phys);
5e4e6e3f	192	int (_unpoint) (struct mtd_info mtd, loff_t from, size_t len);
3c3c10bb AB	193	unsigned long (_get_unmapped_area) (struct mtd_info mtd,
	194	unsigned long len,
	195	unsigned long offset,
	196	unsigned long flags);
	197	int (_read) (struct mtd_info mtd, loff_t from, size_t len,
	198	size_t retlen, u_char buf);
	199	int (_write) (struct mtd_info mtd, loff_t to, size_t len,
	200	size_t retlen, const u_char buf);
	201	int (_panic_write) (struct mtd_info mtd, loff_t to, size_t len,
	202	size_t retlen, const u_char buf);
	203	int (_read_oob) (struct mtd_info mtd, loff_t from,
a2cc5ba0	204	struct mtd_oob_ops *ops);
3c3c10bb AB	205	int (_write_oob) (struct mtd_info mtd, loff_t to,
3c3c10bb AB	206	struct mtd_oob_ops *ops);
4b78fc42 CR	207	int (_get_fact_prot_info) (struct mtd_info mtd, size_t len,
4b78fc42 CR	208	size_t retlen, struct otp_info buf);
3c3c10bb AB	209	int (_read_fact_prot_reg) (struct mtd_info mtd, loff_t from,
3c3c10bb AB	210	size_t len, size_t retlen, u_char buf);
4b78fc42 CR	211	int (_get_user_prot_info) (struct mtd_info mtd, size_t len,
4b78fc42 CR	212	size_t retlen, struct otp_info buf);
3c3c10bb AB	213	int (_read_user_prot_reg) (struct mtd_info mtd, loff_t from,
	214	size_t len, size_t retlen, u_char buf);
	215	int (_write_user_prot_reg) (struct mtd_info mtd, loff_t to,
	216	size_t len, size_t retlen, u_char buf);
	217	int (_lock_user_prot_reg) (struct mtd_info mtd, loff_t from,
	218	size_t len);
	219	int (_writev) (struct mtd_info mtd, const struct kvec *vecs,
b0a31f7b	220	unsigned long count, loff_t to, size_t *retlen);
3c3c10bb AB	221	void (_sync) (struct mtd_info mtd);
	222	int (_lock) (struct mtd_info mtd, loff_t ofs, uint64_t len);
	223	int (_unlock) (struct mtd_info mtd, loff_t ofs, uint64_t len);
	224	int (_is_locked) (struct mtd_info mtd, loff_t ofs, uint64_t len);
8471bb73	225	int (_block_isreserved) (struct mtd_info mtd, loff_t ofs);
3c3c10bb AB	226	int (_block_isbad) (struct mtd_info mtd, loff_t ofs);
	227	int (_block_markbad) (struct mtd_info mtd, loff_t ofs);
	228	int (_suspend) (struct mtd_info mtd);
	229	void (_resume) (struct mtd_info mtd);
3efe41be	230	void (_reboot) (struct mtd_info mtd);
a88d2dc6 AB	231	/*
	232	* If the driver is something smart, like UBI, it may need to maintain
	233	* its own reference counting. The below functions are only for driver.
	234	*/
3c3c10bb AB	235	int (_get_device) (struct mtd_info mtd);
3c3c10bb AB	236	void (_put_device) (struct mtd_info mtd);
402d3265 DH	237
	238	/* Backing device capabilities for this device
	239	* - provides mmap capabilities
	240	*/
	241	struct backing_dev_info *backing_dev_info;
	242
963a6fb0 NP	243	struct notifier_block reboot_notifier; /* default mode before reboot */
963a6fb0 NP	244
7fac4648 TG	245	/* ECC status information */
7fac4648 TG	246	struct mtd_ecc_stats ecc_stats;
29072b96 TG	247	/* Subpage shift (NAND) */
29072b96 TG	248	int subpage_sft;
7fac4648	249
1da177e4 LT	250	void *priv;
	251
	252	struct module *owner;
1f24b5a8	253	struct device dev;
1da177e4 LT	254	int usecount;
	255	};
	256
28b8b26b BN	257	static inline void mtd_set_of_node(struct mtd_info *mtd,
	258	struct device_node *np)
	259	{
	260	mtd->dev.of_node = np;
	261	}
	262
	263	static inline struct device_node mtd_get_of_node(struct mtd_info mtd)
	264	{
	265	return mtd->dev.of_node;
	266	}
	267
8273a0c9 AB	268	int mtd_erase(struct mtd_info mtd, struct erase_info instr);
	269	int mtd_point(struct mtd_info mtd, loff_t from, size_t len, size_t retlen,
	270	void *virt, resource_size_t phys);
	271	int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
	272	unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
	273	unsigned long offset, unsigned long flags);
	274	int mtd_read(struct mtd_info mtd, loff_t from, size_t len, size_t retlen,
	275	u_char *buf);
	276	int mtd_write(struct mtd_info mtd, loff_t to, size_t len, size_t retlen,
	277	const u_char *buf);
	278	int mtd_panic_write(struct mtd_info mtd, loff_t to, size_t len, size_t retlen,
	279	const u_char *buf);
7ae79d7f	280
d2d48480	281	int mtd_read_oob(struct mtd_info mtd, loff_t from, struct mtd_oob_ops ops);
fd2819bb	282
a2cc5ba0 AB	283	static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
	284	struct mtd_oob_ops *ops)
	285	{
9cf075f8	286	ops->retlen = ops->oobretlen = 0;
3c3c10bb	287	if (!mtd->_write_oob)
dac2639f	288	return -EOPNOTSUPP;
664addc2 AB	289	if (!(mtd->flags & MTD_WRITEABLE))
664addc2 AB	290	return -EROFS;
3c3c10bb	291	return mtd->_write_oob(mtd, to, ops);
a2cc5ba0 AB	292	}
a2cc5ba0 AB	293
4b78fc42 CR	294	int mtd_get_fact_prot_info(struct mtd_info mtd, size_t len, size_t retlen,
4b78fc42 CR	295	struct otp_info *buf);
de3cac93 AB	296	int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
de3cac93 AB	297	size_t retlen, u_char buf);
4b78fc42 CR	298	int mtd_get_user_prot_info(struct mtd_info mtd, size_t len, size_t retlen,
4b78fc42 CR	299	struct otp_info *buf);
de3cac93 AB	300	int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
	301	size_t retlen, u_char buf);
	302	int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
	303	size_t retlen, u_char buf);
	304	int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
4403dbfb	305
1dbebd32 AB	306	int mtd_writev(struct mtd_info mtd, const struct kvec vecs,
1dbebd32 AB	307	unsigned long count, loff_t to, size_t *retlen);
b0a31f7b	308
85f2f2a8 AB	309	static inline void mtd_sync(struct mtd_info *mtd)
85f2f2a8 AB	310	{
3c3c10bb AB	311	if (mtd->_sync)
3c3c10bb AB	312	mtd->_sync(mtd);
85f2f2a8 AB	313	}
85f2f2a8 AB	314
8273a0c9 AB	315	int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
	316	int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
	317	int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
8471bb73	318	int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
8273a0c9 AB	319	int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
8273a0c9 AB	320	int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
e95e9786	321
3fe4bae8 AB	322	static inline int mtd_suspend(struct mtd_info *mtd)
3fe4bae8 AB	323	{
3c3c10bb	324	return mtd->_suspend ? mtd->_suspend(mtd) : 0;
3fe4bae8 AB	325	}
3fe4bae8 AB	326
ead995f8 AB	327	static inline void mtd_resume(struct mtd_info *mtd)
ead995f8 AB	328	{
3c3c10bb AB	329	if (mtd->_resume)
3c3c10bb AB	330	mtd->_resume(mtd);
ead995f8 AB	331	}
ead995f8 AB	332
26cdb67c	333	static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
69423d99 AH	334	{
	335	if (mtd->erasesize_shift)
	336	return sz >> mtd->erasesize_shift;
	337	do_div(sz, mtd->erasesize);
	338	return sz;
	339	}
	340
26cdb67c	341	static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
69423d99 AH	342	{
	343	if (mtd->erasesize_shift)
	344	return sz & mtd->erasesize_mask;
	345	return do_div(sz, mtd->erasesize);
	346	}
	347
26cdb67c	348	static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
69423d99 AH	349	{
	350	if (mtd->writesize_shift)
	351	return sz >> mtd->writesize_shift;
	352	do_div(sz, mtd->writesize);
	353	return sz;
	354	}
	355
26cdb67c	356	static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
69423d99 AH	357	{
	358	if (mtd->writesize_shift)
	359	return sz & mtd->writesize_mask;
	360	return do_div(sz, mtd->writesize);
	361	}
1da177e4	362
fc002e3c AB	363	static inline int mtd_has_oob(const struct mtd_info *mtd)
fc002e3c AB	364	{
3c3c10bb	365	return mtd->_read_oob && mtd->_write_oob;
fc002e3c AB	366	}
fc002e3c AB	367
818b9739 HS	368	static inline int mtd_type_is_nand(const struct mtd_info *mtd)
	369	{
	370	return mtd->type == MTD_NANDFLASH \|\| mtd->type == MTD_MLCNANDFLASH;
	371	}
	372
8f461a73 AB	373	static inline int mtd_can_have_bb(const struct mtd_info *mtd)
8f461a73 AB	374	{
3c3c10bb	375	return !!mtd->_block_isbad;
8f461a73 AB	376	}
8f461a73 AB	377
1da177e4 LT	378	/* Kernel-side ioctl definitions */
1da177e4 LT	379
f5671ab3	380	struct mtd_partition;
c7975330	381	struct mtd_part_parser_data;
f5671ab3	382
1c4c215c	383	extern int mtd_device_parse_register(struct mtd_info *mtd,
26a47346 AB	384	const char * const *part_probe_types,
	385	struct mtd_part_parser_data *parser_data,
	386	const struct mtd_partition *defparts,
	387	int defnr_parts);
15c60a50 DES	388	#define mtd_device_register(master, parts, nr_parts) \
15c60a50 DES	389	mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
f5671ab3	390	extern int mtd_device_unregister(struct mtd_info *master);
1da177e4	391	extern struct mtd_info get_mtd_device(struct mtd_info mtd, int num);
3bd45657 ML	392	extern int __get_mtd_device(struct mtd_info *mtd);
3bd45657 ML	393	extern void __put_mtd_device(struct mtd_info *mtd);
7799308f	394	extern struct mtd_info get_mtd_device_nm(const char name);
1da177e4 LT	395	extern void put_mtd_device(struct mtd_info *mtd);
	396
	397
	398	struct mtd_notifier {
	399	void (add)(struct mtd_info mtd);
	400	void (remove)(struct mtd_info mtd);
	401	struct list_head list;
	402	};
	403
	404
	405	extern void register_mtd_user (struct mtd_notifier *new);
	406	extern int unregister_mtd_user (struct mtd_notifier *old);
33b53716 GE	407	void mtd_kmalloc_up_to(const struct mtd_info mtd, size_t *size);
33b53716 GE	408
1da177e4	409	void mtd_erase_callback(struct erase_info *instr);
1da177e4	410
7387ce77 BN	411	static inline int mtd_is_bitflip(int err) {
	412	return err == -EUCLEAN;
	413	}
	414
	415	static inline int mtd_is_eccerr(int err) {
	416	return err == -EBADMSG;
	417	}
	418
	419	static inline int mtd_is_bitflip_or_eccerr(int err) {
	420	return mtd_is_bitflip(err) \|\| mtd_is_eccerr(err);
	421	}
1da177e4	422
b4caecd4 CH	423	unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
b4caecd4 CH	424
1da177e4	425	#endif /* __MTD_MTD_H__ */