[linux-2.6-block.git] / include / linux / mtd / map.h

/*
 * Copyright © 2000-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
 *
 */

/* Overhauled routines for dealing with different mmap regions of flash */

#ifndef __LINUX_MTD_MAP_H__
#define __LINUX_MTD_MAP_H__

#include <linux/types.h>
#include <linux/list.h>
#include <linux/string.h>
#include <linux/bug.h>
#include <linux/kernel.h>

#include <asm/unaligned.h>
#include <asm/io.h>
#include <asm/barrier.h>

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
#define map_bankwidth(map) 1
#define map_bankwidth_is_1(map) (map_bankwidth(map) == 1)
#define map_bankwidth_is_large(map) (0)
#define map_words(map) (1)
#define MAX_MAP_BANKWIDTH 1
#else
#define map_bankwidth_is_1(map) (0)
#endif

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
# ifdef map_bankwidth
#  undef map_bankwidth
#  define map_bankwidth(map) ((map)->bankwidth)
# else
#  define map_bankwidth(map) 2
#  define map_bankwidth_is_large(map) (0)
#  define map_words(map) (1)
# endif
#define map_bankwidth_is_2(map) (map_bankwidth(map) == 2)
#undef MAX_MAP_BANKWIDTH
#define MAX_MAP_BANKWIDTH 2
#else
#define map_bankwidth_is_2(map) (0)
#endif

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
# ifdef map_bankwidth
#  undef map_bankwidth
#  define map_bankwidth(map) ((map)->bankwidth)
# else
#  define map_bankwidth(map) 4
#  define map_bankwidth_is_large(map) (0)
#  define map_words(map) (1)
# endif
#define map_bankwidth_is_4(map) (map_bankwidth(map) == 4)
#undef MAX_MAP_BANKWIDTH
#define MAX_MAP_BANKWIDTH 4
#else
#define map_bankwidth_is_4(map) (0)
#endif

/* ensure we never evaluate anything shorted than an unsigned long
 * to zero, and ensure we'll never miss the end of an comparison (bjd) */

#define map_calc_words(map) ((map_bankwidth(map) + (sizeof(unsigned long)-1))/ sizeof(unsigned long))

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
# ifdef map_bankwidth
#  undef map_bankwidth
#  define map_bankwidth(map) ((map)->bankwidth)
#  if BITS_PER_LONG < 64
#   undef map_bankwidth_is_large
#   define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
#   undef map_words
#   define map_words(map) map_calc_words(map)
#  endif
# else
#  define map_bankwidth(map) 8
#  define map_bankwidth_is_large(map) (BITS_PER_LONG < 64)
#  define map_words(map) map_calc_words(map)
# endif
#define map_bankwidth_is_8(map) (map_bankwidth(map) == 8)
#undef MAX_MAP_BANKWIDTH
#define MAX_MAP_BANKWIDTH 8
#else
#define map_bankwidth_is_8(map) (0)
#endif

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
# ifdef map_bankwidth
#  undef map_bankwidth
#  define map_bankwidth(map) ((map)->bankwidth)
#  undef map_bankwidth_is_large
#  define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
#  undef map_words
#  define map_words(map) map_calc_words(map)
# else
#  define map_bankwidth(map) 16
#  define map_bankwidth_is_large(map) (1)
#  define map_words(map) map_calc_words(map)
# endif
#define map_bankwidth_is_16(map) (map_bankwidth(map) == 16)
#undef MAX_MAP_BANKWIDTH
#define MAX_MAP_BANKWIDTH 16
#else
#define map_bankwidth_is_16(map) (0)
#endif

#ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
# ifdef map_bankwidth
#  undef map_bankwidth
#  define map_bankwidth(map) ((map)->bankwidth)
#  undef map_bankwidth_is_large
#  define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
#  undef map_words
#  define map_words(map) map_calc_words(map)
# else
#  define map_bankwidth(map) 32
#  define map_bankwidth_is_large(map) (1)
#  define map_words(map) map_calc_words(map)
# endif
#define map_bankwidth_is_32(map) (map_bankwidth(map) == 32)
#undef MAX_MAP_BANKWIDTH
#define MAX_MAP_BANKWIDTH 32
#else
#define map_bankwidth_is_32(map) (0)
#endif

#ifndef map_bankwidth
#warning "No CONFIG_MTD_MAP_BANK_WIDTH_xx selected. No NOR chip support can work"
static inline int map_bankwidth(void *map)
{
	BUG();
	return 0;
}
#define map_bankwidth_is_large(map) (0)
#define map_words(map) (0)
#define MAX_MAP_BANKWIDTH 1
#endif

static inline int map_bankwidth_supported(int w)
{
	switch (w) {
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
	case 1:
#endif
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
	case 2:
#endif
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
	case 4:
#endif
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
	case 8:
#endif
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
	case 16:
#endif
#ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
	case 32:
#endif
		return 1;

	default:
		return 0;
	}
}

#define MAX_MAP_LONGS ( ((MAX_MAP_BANKWIDTH*8) + BITS_PER_LONG - 1) / BITS_PER_LONG )

typedef union {
	unsigned long x[MAX_MAP_LONGS];
} map_word;

/* The map stuff is very simple. You fill in your struct map_info with
   a handful of routines for accessing the device, making sure they handle
   paging etc. correctly if your device needs it. Then you pass it off
   to a chip probe routine -- either JEDEC or CFI probe or both -- via
   do_map_probe(). If a chip is recognised, the probe code will invoke the
   appropriate chip driver (if present) and return a struct mtd_info.
   At which point, you fill in the mtd->module with your own module
   address, and register it with the MTD core code. Or you could partition
   it and register the partitions instead, or keep it for your own private
   use; whatever.

   The mtd->priv field will point to the struct map_info, and any further
   private data required by the chip driver is linked from the
   mtd->priv->fldrv_priv field. This allows the map driver to get at
   the destructor function map->fldrv_destroy() when it's tired
   of living.
*/

struct map_info {
	const char *name;
	unsigned long size;
	resource_size_t phys;
#define NO_XIP (-1UL)

	void __iomem *virt;
	void *cached;

	int swap; /* this mapping's byte-swapping requirement */
	int bankwidth; /* in octets. This isn't necessarily the width
		       of actual bus cycles -- it's the repeat interval
		      in bytes, before you are talking to the first chip again.
		      */

#ifdef CONFIG_MTD_COMPLEX_MAPPINGS
	map_word (*read)(struct map_info *, unsigned long);
	void (*copy_from)(struct map_info *, void *, unsigned long, ssize_t);

	void (*write)(struct map_info *, const map_word, unsigned long);
	void (*copy_to)(struct map_info *, unsigned long, const void *, ssize_t);

	/* We can perhaps put in 'point' and 'unpoint' methods, if we really
	   want to enable XIP for non-linear mappings. Not yet though. */
#endif
	/* It's possible for the map driver to use cached memory in its
	   copy_from implementation (and _only_ with copy_from).  However,
	   when the chip driver knows some flash area has changed contents,
	   it will signal it to the map driver through this routine to let
	   the map driver invalidate the corresponding cache as needed.
	   If there is no cache to care about this can be set to NULL. */
	void (*inval_cache)(struct map_info *, unsigned long, ssize_t);

	/* set_vpp() must handle being reentered -- enable, enable, disable
	   must leave it enabled. */
	void (*set_vpp)(struct map_info *, int);

	unsigned long pfow_base;
	unsigned long map_priv_1;
	unsigned long map_priv_2;
	struct device_node *device_node;
	void *fldrv_priv;
	struct mtd_chip_driver *fldrv;
};

struct mtd_chip_driver {
	struct mtd_info *(*probe)(struct map_info *map);
	void (*destroy)(struct mtd_info *);
	struct module *module;
	char *name;
	struct list_head list;
};

void register_mtd_chip_driver(struct mtd_chip_driver *);
void unregister_mtd_chip_driver(struct mtd_chip_driver *);

struct mtd_info *do_map_probe(const char *name, struct map_info *map);
void map_destroy(struct mtd_info *mtd);

#define ENABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 1); } while(0)
#define DISABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 0); } while(0)

#define INVALIDATE_CACHED_RANGE(map, from, size) \
	do { if(map->inval_cache) map->inval_cache(map, from, size); } while(0)


static inline int map_word_equal(struct map_info *map, map_word val1, map_word val2)
{
	int i;
	for (i=0; i<map_words(map); i++) {
		if (val1.x[i] != val2.x[i])
			return 0;
	}
	return 1;
}

static inline map_word map_word_and(struct map_info *map, map_word val1, map_word val2)
{
	map_word r;
	int i;

	for (i=0; i<map_words(map); i++) {
		r.x[i] = val1.x[i] & val2.x[i];
	}
	return r;
}

static inline map_word map_word_clr(struct map_info *map, map_word val1, map_word val2)
{
	map_word r;
	int i;

	for (i=0; i<map_words(map); i++) {
		r.x[i] = val1.x[i] & ~val2.x[i];
	}
	return r;
}

static inline map_word map_word_or(struct map_info *map, map_word val1, map_word val2)
{
	map_word r;
	int i;

	for (i=0; i<map_words(map); i++) {
		r.x[i] = val1.x[i] | val2.x[i];
	}
	return r;
}

#define map_word_andequal(m, a, b, z) map_word_equal(m, z, map_word_and(m, a, b))

static inline int map_word_bitsset(struct map_info *map, map_word val1, map_word val2)
{
	int i;

	for (i=0; i<map_words(map); i++) {
		if (val1.x[i] & val2.x[i])
			return 1;
	}
	return 0;
}

static inline map_word map_word_load(struct map_info *map, const void *ptr)
{
	map_word r;

	if (map_bankwidth_is_1(map))
		r.x[0] = *(unsigned char *)ptr;
	else if (map_bankwidth_is_2(map))
		r.x[0] = get_unaligned((uint16_t *)ptr);
	else if (map_bankwidth_is_4(map))
		r.x[0] = get_unaligned((uint32_t *)ptr);
#if BITS_PER_LONG >= 64
	else if (map_bankwidth_is_8(map))
		r.x[0] = get_unaligned((uint64_t *)ptr);
#endif
	else if (map_bankwidth_is_large(map))
		memcpy(r.x, ptr, map->bankwidth);
	else
		BUG();

	return r;
}

static inline map_word map_word_load_partial(struct map_info *map, map_word orig, const unsigned char *buf, int start, int len)
{
	int i;

	if (map_bankwidth_is_large(map)) {
		char *dest = (char *)&orig;
		memcpy(dest+start, buf, len);
	} else {
		for (i=start; i < start+len; i++) {
			int bitpos;
#ifdef __LITTLE_ENDIAN
			bitpos = i*8;
#else /* __BIG_ENDIAN */
			bitpos = (map_bankwidth(map)-1-i)*8;
#endif
			orig.x[0] &= ~(0xff << bitpos);
			orig.x[0] |= (unsigned long)buf[i-start] << bitpos;
		}
	}
	return orig;
}

#if BITS_PER_LONG < 64
#define MAP_FF_LIMIT 4
#else
#define MAP_FF_LIMIT 8
#endif

static inline map_word map_word_ff(struct map_info *map)
{
	map_word r;
	int i;

	if (map_bankwidth(map) < MAP_FF_LIMIT) {
		int bw = 8 * map_bankwidth(map);
		r.x[0] = (1UL << bw) - 1;
	} else {
		for (i=0; i<map_words(map); i++)
			r.x[i] = ~0UL;
	}
	return r;
}

static inline map_word inline_map_read(struct map_info *map, unsigned long ofs)
{
	map_word r;

	if (map_bankwidth_is_1(map))
		r.x[0] = __raw_readb(map->virt + ofs);
	else if (map_bankwidth_is_2(map))
		r.x[0] = __raw_readw(map->virt + ofs);
	else if (map_bankwidth_is_4(map))
		r.x[0] = __raw_readl(map->virt + ofs);
#if BITS_PER_LONG >= 64
	else if (map_bankwidth_is_8(map))
		r.x[0] = __raw_readq(map->virt + ofs);
#endif
	else if (map_bankwidth_is_large(map))
		memcpy_fromio(r.x, map->virt+ofs, map->bankwidth);
	else
		BUG();

	return r;
}

static inline void inline_map_write(struct map_info *map, const map_word datum, unsigned long ofs)
{
	if (map_bankwidth_is_1(map))
		__raw_writeb(datum.x[0], map->virt + ofs);
	else if (map_bankwidth_is_2(map))
		__raw_writew(datum.x[0], map->virt + ofs);
	else if (map_bankwidth_is_4(map))
		__raw_writel(datum.x[0], map->virt + ofs);
#if BITS_PER_LONG >= 64
	else if (map_bankwidth_is_8(map))
		__raw_writeq(datum.x[0], map->virt + ofs);
#endif
	else if (map_bankwidth_is_large(map))
		memcpy_toio(map->virt+ofs, datum.x, map->bankwidth);
	else
		BUG();
	mb();
}

static inline void inline_map_copy_from(struct map_info *map, void *to, unsigned long from, ssize_t len)
{
	if (map->cached)
		memcpy(to, (char *)map->cached + from, len);
	else
		memcpy_fromio(to, map->virt + from, len);
}

static inline void inline_map_copy_to(struct map_info *map, unsigned long to, const void *from, ssize_t len)
{
	memcpy_toio(map->virt + to, from, len);
}

#ifdef CONFIG_MTD_COMPLEX_MAPPINGS
#define map_read(map, ofs) (map)->read(map, ofs)
#define map_copy_from(map, to, from, len) (map)->copy_from(map, to, from, len)
#define map_write(map, datum, ofs) (map)->write(map, datum, ofs)
#define map_copy_to(map, to, from, len) (map)->copy_to(map, to, from, len)

extern void simple_map_init(struct map_info *);
#define map_is_linear(map) (map->phys != NO_XIP)

#else
#define map_read(map, ofs) inline_map_read(map, ofs)
#define map_copy_from(map, to, from, len) inline_map_copy_from(map, to, from, len)
#define map_write(map, datum, ofs) inline_map_write(map, datum, ofs)
#define map_copy_to(map, to, from, len) inline_map_copy_to(map, to, from, len)


#define simple_map_init(map) BUG_ON(!map_bankwidth_supported((map)->bankwidth))
#define map_is_linear(map) ({ (void)(map); 1; })

#endif /* !CONFIG_MTD_COMPLEX_MAPPINGS */

#endif /* __LINUX_MTD_MAP_H__ */
Commit	Line	Data
a1452a37 DW	1	/*
	2	* Copyright © 2000-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
	17	*
	18	*/
1da177e4 LT	19
1da177e4 LT	20	/* Overhauled routines for dealing with different mmap regions of flash */
1da177e4 LT	21
	22	#ifndef __LINUX_MTD_MAP_H__
	23	#define __LINUX_MTD_MAP_H__
	24
1da177e4 LT	25	#include <linux/types.h>
1da177e4 LT	26	#include <linux/list.h>
4e57b681	27	#include <linux/string.h>
709c4efb	28	#include <linux/bug.h>
4a422438	29	#include <linux/kernel.h>
4e57b681	30
1da177e4	31	#include <asm/unaligned.h>
1da177e4	32	#include <asm/io.h>
96f951ed	33	#include <asm/barrier.h>
1da177e4 LT	34
	35	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
	36	#define map_bankwidth(map) 1
	37	#define map_bankwidth_is_1(map) (map_bankwidth(map) == 1)
	38	#define map_bankwidth_is_large(map) (0)
	39	#define map_words(map) (1)
	40	#define MAX_MAP_BANKWIDTH 1
	41	#else
	42	#define map_bankwidth_is_1(map) (0)
	43	#endif
	44
	45	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
	46	# ifdef map_bankwidth
	47	# undef map_bankwidth
	48	# define map_bankwidth(map) ((map)->bankwidth)
	49	# else
	50	# define map_bankwidth(map) 2
	51	# define map_bankwidth_is_large(map) (0)
	52	# define map_words(map) (1)
	53	# endif
	54	#define map_bankwidth_is_2(map) (map_bankwidth(map) == 2)
	55	#undef MAX_MAP_BANKWIDTH
	56	#define MAX_MAP_BANKWIDTH 2
	57	#else
	58	#define map_bankwidth_is_2(map) (0)
	59	#endif
	60
	61	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
	62	# ifdef map_bankwidth
	63	# undef map_bankwidth
	64	# define map_bankwidth(map) ((map)->bankwidth)
	65	# else
	66	# define map_bankwidth(map) 4
	67	# define map_bankwidth_is_large(map) (0)
	68	# define map_words(map) (1)
	69	# endif
	70	#define map_bankwidth_is_4(map) (map_bankwidth(map) == 4)
	71	#undef MAX_MAP_BANKWIDTH
	72	#define MAX_MAP_BANKWIDTH 4
	73	#else
	74	#define map_bankwidth_is_4(map) (0)
	75	#endif
	76
	77	/* ensure we never evaluate anything shorted than an unsigned long
	78	* to zero, and ensure we'll never miss the end of an comparison (bjd) */
	79
	80	#define map_calc_words(map) ((map_bankwidth(map) + (sizeof(unsigned long)-1))/ sizeof(unsigned long))
	81
	82	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
	83	# ifdef map_bankwidth
	84	# undef map_bankwidth
	85	# define map_bankwidth(map) ((map)->bankwidth)
	86	# if BITS_PER_LONG < 64
	87	# undef map_bankwidth_is_large
	88	# define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
	89	# undef map_words
	90	# define map_words(map) map_calc_words(map)
	91	# endif
	92	# else
	93	# define map_bankwidth(map) 8
	94	# define map_bankwidth_is_large(map) (BITS_PER_LONG < 64)
	95	# define map_words(map) map_calc_words(map)
	96	# endif
	97	#define map_bankwidth_is_8(map) (map_bankwidth(map) == 8)
98	#undef MAX_MAP_BANKWIDTH
99	#define MAX_MAP_BANKWIDTH 8
100	#else
101	#define map_bankwidth_is_8(map) (0)
102	#endif
103
104	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
105	# ifdef map_bankwidth
106	# undef map_bankwidth
107	# define map_bankwidth(map) ((map)->bankwidth)
108	# undef map_bankwidth_is_large
109	# define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
110	# undef map_words
111	# define map_words(map) map_calc_words(map)
112	# else
113	# define map_bankwidth(map) 16
114	# define map_bankwidth_is_large(map) (1)
115	# define map_words(map) map_calc_words(map)
116	# endif
117	#define map_bankwidth_is_16(map) (map_bankwidth(map) == 16)
118	#undef MAX_MAP_BANKWIDTH
119	#define MAX_MAP_BANKWIDTH 16
120	#else
121	#define map_bankwidth_is_16(map) (0)
122	#endif
123
124	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
125	# ifdef map_bankwidth
126	# undef map_bankwidth
127	# define map_bankwidth(map) ((map)->bankwidth)
128	# undef map_bankwidth_is_large
129	# define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
130	# undef map_words
131	# define map_words(map) map_calc_words(map)
132	# else
133	# define map_bankwidth(map) 32
134	# define map_bankwidth_is_large(map) (1)
135	# define map_words(map) map_calc_words(map)
136	# endif
137	#define map_bankwidth_is_32(map) (map_bankwidth(map) == 32)
138	#undef MAX_MAP_BANKWIDTH
139	#define MAX_MAP_BANKWIDTH 32
140	#else
141	#define map_bankwidth_is_32(map) (0)
142	#endif
143
144	#ifndef map_bankwidth
241651d0 DW	145	#warning "No CONFIG_MTD_MAP_BANK_WIDTH_xx selected. No NOR chip support can work"
	146	static inline int map_bankwidth(void *map)
	147	{
	148	BUG();
	149	return 0;
	150	}
	151	#define map_bankwidth_is_large(map) (0)
	152	#define map_words(map) (0)
	153	#define MAX_MAP_BANKWIDTH 1
1da177e4 LT	154	#endif
	155
	156	static inline int map_bankwidth_supported(int w)
	157	{
	158	switch (w) {
	159	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
	160	case 1:
	161	#endif
	162	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
	163	case 2:
	164	#endif
	165	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
	166	case 4:
	167	#endif
	168	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
	169	case 8:
	170	#endif
	171	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
	172	case 16:
	173	#endif
	174	#ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
	175	case 32:
	176	#endif
	177	return 1;
	178
	179	default:
	180	return 0;
	181	}
	182	}
	183
	184	#define MAX_MAP_LONGS ( ((MAX_MAP_BANKWIDTH*8) + BITS_PER_LONG - 1) / BITS_PER_LONG )
	185
	186	typedef union {
	187	unsigned long x[MAX_MAP_LONGS];
	188	} map_word;
	189
	190	/* The map stuff is very simple. You fill in your struct map_info with
	191	a handful of routines for accessing the device, making sure they handle
	192	paging etc. correctly if your device needs it. Then you pass it off
	193	to a chip probe routine -- either JEDEC or CFI probe or both -- via
	194	do_map_probe(). If a chip is recognised, the probe code will invoke the
	195	appropriate chip driver (if present) and return a struct mtd_info.
61ecfa87	196	At which point, you fill in the mtd->module with your own module
1da177e4 LT	197	address, and register it with the MTD core code. Or you could partition
	198	it and register the partitions instead, or keep it for your own private
	199	use; whatever.
61ecfa87	200
1da177e4	201	The mtd->priv field will point to the struct map_info, and any further
61ecfa87 TG	202	private data required by the chip driver is linked from the
61ecfa87 TG	203	mtd->priv->fldrv_priv field. This allows the map driver to get at
1da177e4 LT	204	the destructor function map->fldrv_destroy() when it's tired
	205	of living.
	206	*/
	207
	208	struct map_info {
eadcf0d7	209	const char *name;
1da177e4	210	unsigned long size;
0d36da3b	211	resource_size_t phys;
1da177e4 LT	212	#define NO_XIP (-1UL)
	213
	214	void __iomem *virt;
	215	void *cached;
	216
8e987465	217	int swap; /* this mapping's byte-swapping requirement */
1da177e4 LT	218	int bankwidth; /* in octets. This isn't necessarily the width
	219	of actual bus cycles -- it's the repeat interval
	220	in bytes, before you are talking to the first chip again.
	221	*/
	222
	223	#ifdef CONFIG_MTD_COMPLEX_MAPPINGS
	224	map_word (read)(struct map_info , unsigned long);
	225	void (copy_from)(struct map_info , void *, unsigned long, ssize_t);
	226
	227	void (write)(struct map_info , const map_word, unsigned long);
	228	void (copy_to)(struct map_info , unsigned long, const void *, ssize_t);
	229
	230	/* We can perhaps put in 'point' and 'unpoint' methods, if we really
	231	want to enable XIP for non-linear mappings. Not yet though. */
	232	#endif
	233	/* It's possible for the map driver to use cached memory in its
	234	copy_from implementation (and _only_ with copy_from). However,
	235	when the chip driver knows some flash area has changed contents,
	236	it will signal it to the map driver through this routine to let
	237	the map driver invalidate the corresponding cache as needed.
	238	If there is no cache to care about this can be set to NULL. */
	239	void (inval_cache)(struct map_info , unsigned long, ssize_t);
	240
61ecfa87	241	/* set_vpp() must handle being reentered -- enable, enable, disable
1da177e4 LT	242	must leave it enabled. */
	243	void (set_vpp)(struct map_info , int);
	244
d13e51e7	245	unsigned long pfow_base;
1da177e4 LT	246	unsigned long map_priv_1;
1da177e4 LT	247	unsigned long map_priv_2;
1648eaaa	248	struct device_node *device_node;
1da177e4 LT	249	void *fldrv_priv;
	250	struct mtd_chip_driver *fldrv;
	251	};
	252
	253	struct mtd_chip_driver {
	254	struct mtd_info (probe)(struct map_info *map);
	255	void (destroy)(struct mtd_info );
	256	struct module *module;
	257	char *name;
	258	struct list_head list;
	259	};
	260
	261	void register_mtd_chip_driver(struct mtd_chip_driver *);
	262	void unregister_mtd_chip_driver(struct mtd_chip_driver *);
	263
	264	struct mtd_info do_map_probe(const char name, struct map_info *map);
	265	void map_destroy(struct mtd_info *mtd);
	266
	267	#define ENABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 1); } while(0)
	268	#define DISABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 0); } while(0)
	269
	270	#define INVALIDATE_CACHED_RANGE(map, from, size) \
	271	do { if(map->inval_cache) map->inval_cache(map, from, size); } while(0)
	272
	273
	274	static inline int map_word_equal(struct map_info *map, map_word val1, map_word val2)
	275	{
	276	int i;
	277	for (i=0; i<map_words(map); i++) {
	278	if (val1.x[i] != val2.x[i])
	279	return 0;
	280	}
	281	return 1;
	282	}
	283
	284	static inline map_word map_word_and(struct map_info *map, map_word val1, map_word val2)
	285	{
	286	map_word r;
	287	int i;
	288
	289	for (i=0; i<map_words(map); i++) {
	290	r.x[i] = val1.x[i] & val2.x[i];
	291	}
	292	return r;
	293	}
	294
f77814dd NP	295	static inline map_word map_word_clr(struct map_info *map, map_word val1, map_word val2)
	296	{
	297	map_word r;
	298	int i;
	299
	300	for (i=0; i<map_words(map); i++) {
	301	r.x[i] = val1.x[i] & ~val2.x[i];
	302	}
	303	return r;
	304	}
	305
1da177e4 LT	306	static inline map_word map_word_or(struct map_info *map, map_word val1, map_word val2)
	307	{
	308	map_word r;
	309	int i;
	310
	311	for (i=0; i<map_words(map); i++) {
	312	r.x[i] = val1.x[i] \| val2.x[i];
	313	}
	314	return r;
	315	}
f77814dd	316
1da177e4 LT	317	#define map_word_andequal(m, a, b, z) map_word_equal(m, z, map_word_and(m, a, b))
	318
	319	static inline int map_word_bitsset(struct map_info *map, map_word val1, map_word val2)
	320	{
	321	int i;
	322
	323	for (i=0; i<map_words(map); i++) {
	324	if (val1.x[i] & val2.x[i])
	325	return 1;
	326	}
	327	return 0;
	328	}
	329
	330	static inline map_word map_word_load(struct map_info map, const void ptr)
	331	{
24dea0c9	332	map_word r;
1da177e4 LT	333
	334	if (map_bankwidth_is_1(map))
	335	r.x[0] = (unsigned char )ptr;
	336	else if (map_bankwidth_is_2(map))
	337	r.x[0] = get_unaligned((uint16_t *)ptr);
	338	else if (map_bankwidth_is_4(map))
	339	r.x[0] = get_unaligned((uint32_t *)ptr);
	340	#if BITS_PER_LONG >= 64
	341	else if (map_bankwidth_is_8(map))
	342	r.x[0] = get_unaligned((uint64_t *)ptr);
	343	#endif
	344	else if (map_bankwidth_is_large(map))
	345	memcpy(r.x, ptr, map->bankwidth);
24dea0c9 DES	346	else
24dea0c9 DES	347	BUG();
1da177e4 LT	348
	349	return r;
	350	}
	351
	352	static inline map_word map_word_load_partial(struct map_info map, map_word orig, const unsigned char buf, int start, int len)
	353	{
	354	int i;
	355
	356	if (map_bankwidth_is_large(map)) {
	357	char dest = (char )&orig;
	358	memcpy(dest+start, buf, len);
	359	} else {
	360	for (i=start; i < start+len; i++) {
	361	int bitpos;
	362	#ifdef __LITTLE_ENDIAN
	363	bitpos = i*8;
	364	#else /* __BIG_ENDIAN */
	365	bitpos = (map_bankwidth(map)-1-i)*8;
	366	#endif
	367	orig.x[0] &= ~(0xff << bitpos);
a4d62bab	368	orig.x[0] \|= (unsigned long)buf[i-start] << bitpos;
1da177e4 LT	369	}
	370	}
	371	return orig;
	372	}
	373
3a3ab48c TG	374	#if BITS_PER_LONG < 64
	375	#define MAP_FF_LIMIT 4
	376	#else
	377	#define MAP_FF_LIMIT 8
	378	#endif
	379
1da177e4 LT	380	static inline map_word map_word_ff(struct map_info *map)
	381	{
	382	map_word r;
	383	int i;
61ecfa87	384
b0435695	385	if (map_bankwidth(map) < MAP_FF_LIMIT) {
a8aff8ab	386	int bw = 8 * map_bankwidth(map);
a4d62bab	387	r.x[0] = (1UL << bw) - 1;
3a3ab48c TG	388	} else {
	389	for (i=0; i<map_words(map); i++)
	390	r.x[i] = ~0UL;
1da177e4 LT	391	}
	392	return r;
	393	}
f77814dd	394
1da177e4 LT	395	static inline map_word inline_map_read(struct map_info *map, unsigned long ofs)
1da177e4 LT	396	{
24dea0c9	397	map_word r;
1da177e4 LT	398
	399	if (map_bankwidth_is_1(map))
	400	r.x[0] = __raw_readb(map->virt + ofs);
	401	else if (map_bankwidth_is_2(map))
	402	r.x[0] = __raw_readw(map->virt + ofs);
	403	else if (map_bankwidth_is_4(map))
	404	r.x[0] = __raw_readl(map->virt + ofs);
	405	#if BITS_PER_LONG >= 64
	406	else if (map_bankwidth_is_8(map))
	407	r.x[0] = __raw_readq(map->virt + ofs);
	408	#endif
	409	else if (map_bankwidth_is_large(map))
	410	memcpy_fromio(r.x, map->virt+ofs, map->bankwidth);
9ea59738 KC	411	else
9ea59738 KC	412	BUG();
1da177e4 LT	413
	414	return r;
	415	}
	416
	417	static inline void inline_map_write(struct map_info *map, const map_word datum, unsigned long ofs)
	418	{
	419	if (map_bankwidth_is_1(map))
	420	__raw_writeb(datum.x[0], map->virt + ofs);
	421	else if (map_bankwidth_is_2(map))
	422	__raw_writew(datum.x[0], map->virt + ofs);
	423	else if (map_bankwidth_is_4(map))
	424	__raw_writel(datum.x[0], map->virt + ofs);
	425	#if BITS_PER_LONG >= 64
	426	else if (map_bankwidth_is_8(map))
	427	__raw_writeq(datum.x[0], map->virt + ofs);
	428	#endif
	429	else if (map_bankwidth_is_large(map))
	430	memcpy_toio(map->virt+ofs, datum.x, map->bankwidth);
24dea0c9 DES	431	else
24dea0c9 DES	432	BUG();
1da177e4 LT	433	mb();
	434	}
	435
	436	static inline void inline_map_copy_from(struct map_info map, void to, unsigned long from, ssize_t len)
	437	{
	438	if (map->cached)
	439	memcpy(to, (char *)map->cached + from, len);
	440	else
	441	memcpy_fromio(to, map->virt + from, len);
	442	}
	443
	444	static inline void inline_map_copy_to(struct map_info map, unsigned long to, const void from, ssize_t len)
	445	{
	446	memcpy_toio(map->virt + to, from, len);
	447	}
	448
	449	#ifdef CONFIG_MTD_COMPLEX_MAPPINGS
	450	#define map_read(map, ofs) (map)->read(map, ofs)
	451	#define map_copy_from(map, to, from, len) (map)->copy_from(map, to, from, len)
	452	#define map_write(map, datum, ofs) (map)->write(map, datum, ofs)
	453	#define map_copy_to(map, to, from, len) (map)->copy_to(map, to, from, len)
	454
	455	extern void simple_map_init(struct map_info *);
	456	#define map_is_linear(map) (map->phys != NO_XIP)
	457
	458	#else
	459	#define map_read(map, ofs) inline_map_read(map, ofs)
	460	#define map_copy_from(map, to, from, len) inline_map_copy_from(map, to, from, len)
	461	#define map_write(map, datum, ofs) inline_map_write(map, datum, ofs)
	462	#define map_copy_to(map, to, from, len) inline_map_copy_to(map, to, from, len)
	463
	464
	465	#define simple_map_init(map) BUG_ON(!map_bankwidth_supported((map)->bankwidth))
f16407d7	466	#define map_is_linear(map) ({ (void)(map); 1; })
1da177e4 LT	467
	468	#endif /* !CONFIG_MTD_COMPLEX_MAPPINGS */
	469
	470	#endif /* __LINUX_MTD_MAP_H__ */