]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/mtd/map.h
2 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org> et al.
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.
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.
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
20 /* Overhauled routines for dealing with different mmap regions of flash */
22 #ifndef __LINUX_MTD_MAP_H__
23 #define __LINUX_MTD_MAP_H__
25 #include <linux/types.h>
26 #include <linux/list.h>
27 #include <linux/string.h>
28 #include <linux/bug.h>
29 #include <linux/kernel.h>
31 #include <asm/unaligned.h>
32 #include <asm/system.h>
34 #include <asm/barrier.h>
36 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
37 #define map_bankwidth(map) 1
38 #define map_bankwidth_is_1(map) (map_bankwidth(map) == 1)
39 #define map_bankwidth_is_large(map) (0)
40 #define map_words(map) (1)
41 #define MAX_MAP_BANKWIDTH 1
43 #define map_bankwidth_is_1(map) (0)
46 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
49 # define map_bankwidth(map) ((map)->bankwidth)
51 # define map_bankwidth(map) 2
52 # define map_bankwidth_is_large(map) (0)
53 # define map_words(map) (1)
55 #define map_bankwidth_is_2(map) (map_bankwidth(map) == 2)
56 #undef MAX_MAP_BANKWIDTH
57 #define MAX_MAP_BANKWIDTH 2
59 #define map_bankwidth_is_2(map) (0)
62 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
65 # define map_bankwidth(map) ((map)->bankwidth)
67 # define map_bankwidth(map) 4
68 # define map_bankwidth_is_large(map) (0)
69 # define map_words(map) (1)
71 #define map_bankwidth_is_4(map) (map_bankwidth(map) == 4)
72 #undef MAX_MAP_BANKWIDTH
73 #define MAX_MAP_BANKWIDTH 4
75 #define map_bankwidth_is_4(map) (0)
78 /* ensure we never evaluate anything shorted than an unsigned long
79 * to zero, and ensure we'll never miss the end of an comparison (bjd) */
81 #define map_calc_words(map) ((map_bankwidth(map) + (sizeof(unsigned long)-1))/ sizeof(unsigned long))
83 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
86 # define map_bankwidth(map) ((map)->bankwidth)
87 # if BITS_PER_LONG < 64
88 # undef map_bankwidth_is_large
89 # define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
91 # define map_words(map) map_calc_words(map)
94 # define map_bankwidth(map) 8
95 # define map_bankwidth_is_large(map) (BITS_PER_LONG < 64)
96 # define map_words(map) map_calc_words(map)
98 #define map_bankwidth_is_8(map) (map_bankwidth(map) == 8)
99 #undef MAX_MAP_BANKWIDTH
100 #define MAX_MAP_BANKWIDTH 8
102 #define map_bankwidth_is_8(map) (0)
105 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
106 # ifdef map_bankwidth
107 # undef map_bankwidth
108 # define map_bankwidth(map) ((map)->bankwidth)
109 # undef map_bankwidth_is_large
110 # define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
112 # define map_words(map) map_calc_words(map)
114 # define map_bankwidth(map) 16
115 # define map_bankwidth_is_large(map) (1)
116 # define map_words(map) map_calc_words(map)
118 #define map_bankwidth_is_16(map) (map_bankwidth(map) == 16)
119 #undef MAX_MAP_BANKWIDTH
120 #define MAX_MAP_BANKWIDTH 16
122 #define map_bankwidth_is_16(map) (0)
125 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
126 # ifdef map_bankwidth
127 # undef map_bankwidth
128 # define map_bankwidth(map) ((map)->bankwidth)
129 # undef map_bankwidth_is_large
130 # define map_bankwidth_is_large(map) (map_bankwidth(map) > BITS_PER_LONG/8)
132 # define map_words(map) map_calc_words(map)
134 # define map_bankwidth(map) 32
135 # define map_bankwidth_is_large(map) (1)
136 # define map_words(map) map_calc_words(map)
138 #define map_bankwidth_is_32(map) (map_bankwidth(map) == 32)
139 #undef MAX_MAP_BANKWIDTH
140 #define MAX_MAP_BANKWIDTH 32
142 #define map_bankwidth_is_32(map) (0)
145 #ifndef map_bankwidth
146 #warning "No CONFIG_MTD_MAP_BANK_WIDTH_xx selected. No NOR chip support can work"
147 static inline int map_bankwidth(void *map
)
152 #define map_bankwidth_is_large(map) (0)
153 #define map_words(map) (0)
154 #define MAX_MAP_BANKWIDTH 1
157 static inline int map_bankwidth_supported(int w
)
160 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_1
163 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_2
166 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_4
169 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_8
172 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_16
175 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_32
185 #define MAX_MAP_LONGS ( ((MAX_MAP_BANKWIDTH*8) + BITS_PER_LONG - 1) / BITS_PER_LONG )
188 unsigned long x
[MAX_MAP_LONGS
];
191 /* The map stuff is very simple. You fill in your struct map_info with
192 a handful of routines for accessing the device, making sure they handle
193 paging etc. correctly if your device needs it. Then you pass it off
194 to a chip probe routine -- either JEDEC or CFI probe or both -- via
195 do_map_probe(). If a chip is recognised, the probe code will invoke the
196 appropriate chip driver (if present) and return a struct mtd_info.
197 At which point, you fill in the mtd->module with your own module
198 address, and register it with the MTD core code. Or you could partition
199 it and register the partitions instead, or keep it for your own private
202 The mtd->priv field will point to the struct map_info, and any further
203 private data required by the chip driver is linked from the
204 mtd->priv->fldrv_priv field. This allows the map driver to get at
205 the destructor function map->fldrv_destroy() when it's tired
212 resource_size_t phys
;
213 #define NO_XIP (-1UL)
218 int swap
; /* this mapping's byte-swapping requirement */
219 int bankwidth
; /* in octets. This isn't necessarily the width
220 of actual bus cycles -- it's the repeat interval
221 in bytes, before you are talking to the first chip again.
224 #ifdef CONFIG_MTD_COMPLEX_MAPPINGS
225 map_word (*read
)(struct map_info
*, unsigned long);
226 void (*copy_from
)(struct map_info
*, void *, unsigned long, ssize_t
);
228 void (*write
)(struct map_info
*, const map_word
, unsigned long);
229 void (*copy_to
)(struct map_info
*, unsigned long, const void *, ssize_t
);
231 /* We can perhaps put in 'point' and 'unpoint' methods, if we really
232 want to enable XIP for non-linear mappings. Not yet though. */
234 /* It's possible for the map driver to use cached memory in its
235 copy_from implementation (and _only_ with copy_from). However,
236 when the chip driver knows some flash area has changed contents,
237 it will signal it to the map driver through this routine to let
238 the map driver invalidate the corresponding cache as needed.
239 If there is no cache to care about this can be set to NULL. */
240 void (*inval_cache
)(struct map_info
*, unsigned long, ssize_t
);
242 /* set_vpp() must handle being reentered -- enable, enable, disable
243 must leave it enabled. */
244 void (*set_vpp
)(struct map_info
*, int);
246 unsigned long pfow_base
;
247 unsigned long map_priv_1
;
248 unsigned long map_priv_2
;
250 struct mtd_chip_driver
*fldrv
;
253 struct mtd_chip_driver
{
254 struct mtd_info
*(*probe
)(struct map_info
*map
);
255 void (*destroy
)(struct mtd_info
*);
256 struct module
*module
;
258 struct list_head list
;
261 void register_mtd_chip_driver(struct mtd_chip_driver
*);
262 void unregister_mtd_chip_driver(struct mtd_chip_driver
*);
264 struct mtd_info
*do_map_probe(const char *name
, struct map_info
*map
);
265 void map_destroy(struct mtd_info
*mtd
);
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)
270 #define INVALIDATE_CACHED_RANGE(map, from, size) \
271 do { if(map->inval_cache) map->inval_cache(map, from, size); } while(0)
274 static inline int map_word_equal(struct map_info
*map
, map_word val1
, map_word val2
)
277 for (i
=0; i
<map_words(map
); i
++) {
278 if (val1
.x
[i
] != val2
.x
[i
])
284 static inline map_word
map_word_and(struct map_info
*map
, map_word val1
, map_word val2
)
289 for (i
=0; i
<map_words(map
); i
++) {
290 r
.x
[i
] = val1
.x
[i
] & val2
.x
[i
];
295 static inline map_word
map_word_clr(struct map_info
*map
, map_word val1
, map_word val2
)
300 for (i
=0; i
<map_words(map
); i
++) {
301 r
.x
[i
] = val1
.x
[i
] & ~val2
.x
[i
];
306 static inline map_word
map_word_or(struct map_info
*map
, map_word val1
, map_word val2
)
311 for (i
=0; i
<map_words(map
); i
++) {
312 r
.x
[i
] = val1
.x
[i
] | val2
.x
[i
];
317 #define map_word_andequal(m, a, b, z) map_word_equal(m, z, map_word_and(m, a, b))
319 static inline int map_word_bitsset(struct map_info
*map
, map_word val1
, map_word val2
)
323 for (i
=0; i
<map_words(map
); i
++) {
324 if (val1
.x
[i
] & val2
.x
[i
])
330 static inline map_word
map_word_load(struct map_info
*map
, const void *ptr
)
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
);
344 else if (map_bankwidth_is_large(map
))
345 memcpy(r
.x
, ptr
, map
->bankwidth
);
350 static inline map_word
map_word_load_partial(struct map_info
*map
, map_word orig
, const unsigned char *buf
, int start
, int len
)
354 if (map_bankwidth_is_large(map
)) {
355 char *dest
= (char *)&orig
;
356 memcpy(dest
+start
, buf
, len
);
358 for (i
=start
; i
< start
+len
; i
++) {
360 #ifdef __LITTLE_ENDIAN
362 #else /* __BIG_ENDIAN */
363 bitpos
= (map_bankwidth(map
)-1-i
)*8;
365 orig
.x
[0] &= ~(0xff << bitpos
);
366 orig
.x
[0] |= buf
[i
-start
] << bitpos
;
372 #if BITS_PER_LONG < 64
373 #define MAP_FF_LIMIT 4
375 #define MAP_FF_LIMIT 8
378 static inline map_word
map_word_ff(struct map_info
*map
)
383 if (map_bankwidth(map
) < MAP_FF_LIMIT
) {
384 int bw
= 8 * map_bankwidth(map
);
385 r
.x
[0] = (1 << bw
) - 1;
387 for (i
=0; i
<map_words(map
); i
++)
393 static inline map_word
inline_map_read(struct map_info
*map
, unsigned long ofs
)
397 if (map_bankwidth_is_1(map
))
398 r
.x
[0] = __raw_readb(map
->virt
+ ofs
);
399 else if (map_bankwidth_is_2(map
))
400 r
.x
[0] = __raw_readw(map
->virt
+ ofs
);
401 else if (map_bankwidth_is_4(map
))
402 r
.x
[0] = __raw_readl(map
->virt
+ ofs
);
403 #if BITS_PER_LONG >= 64
404 else if (map_bankwidth_is_8(map
))
405 r
.x
[0] = __raw_readq(map
->virt
+ ofs
);
407 else if (map_bankwidth_is_large(map
))
408 memcpy_fromio(r
.x
, map
->virt
+ofs
, map
->bankwidth
);
415 static inline void inline_map_write(struct map_info
*map
, const map_word datum
, unsigned long ofs
)
417 if (map_bankwidth_is_1(map
))
418 __raw_writeb(datum
.x
[0], map
->virt
+ ofs
);
419 else if (map_bankwidth_is_2(map
))
420 __raw_writew(datum
.x
[0], map
->virt
+ ofs
);
421 else if (map_bankwidth_is_4(map
))
422 __raw_writel(datum
.x
[0], map
->virt
+ ofs
);
423 #if BITS_PER_LONG >= 64
424 else if (map_bankwidth_is_8(map
))
425 __raw_writeq(datum
.x
[0], map
->virt
+ ofs
);
427 else if (map_bankwidth_is_large(map
))
428 memcpy_toio(map
->virt
+ofs
, datum
.x
, map
->bankwidth
);
432 static inline void inline_map_copy_from(struct map_info
*map
, void *to
, unsigned long from
, ssize_t len
)
435 memcpy(to
, (char *)map
->cached
+ from
, len
);
437 memcpy_fromio(to
, map
->virt
+ from
, len
);
440 static inline void inline_map_copy_to(struct map_info
*map
, unsigned long to
, const void *from
, ssize_t len
)
442 memcpy_toio(map
->virt
+ to
, from
, len
);
445 #ifdef CONFIG_MTD_COMPLEX_MAPPINGS
446 #define map_read(map, ofs) (map)->read(map, ofs)
447 #define map_copy_from(map, to, from, len) (map)->copy_from(map, to, from, len)
448 #define map_write(map, datum, ofs) (map)->write(map, datum, ofs)
449 #define map_copy_to(map, to, from, len) (map)->copy_to(map, to, from, len)
451 extern void simple_map_init(struct map_info
*);
452 #define map_is_linear(map) (map->phys != NO_XIP)
455 #define map_read(map, ofs) inline_map_read(map, ofs)
456 #define map_copy_from(map, to, from, len) inline_map_copy_from(map, to, from, len)
457 #define map_write(map, datum, ofs) inline_map_write(map, datum, ofs)
458 #define map_copy_to(map, to, from, len) inline_map_copy_to(map, to, from, len)
461 #define simple_map_init(map) BUG_ON(!map_bankwidth_supported((map)->bankwidth))
462 #define map_is_linear(map) ({ (void)(map); 1; })
464 #endif /* !CONFIG_MTD_COMPLEX_MAPPINGS */
466 #endif /* __LINUX_MTD_MAP_H__ */