1 /* 2 * Copyright © 2000-2010 David Woodhouse <[email protected]> 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 */ 19 20 /* Overhauled routines for dealing with different mmap regions of flash */ 21 22 #ifndef __LINUX_MTD_MAP_H__ 23 #define __LINUX_MTD_MAP_H__ 24 25 #include <linux/types.h> 26 #include <linux/list.h> 27 #include <linux/string.h> 28 #include <linux/bug.h> 29 30 #include <linux/mtd/compatmac.h> 31 32 #include <asm/unaligned.h> 33 #include <asm/system.h> 34 #include <asm/io.h> 35 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 42 #else 43 #define map_bankwidth_is_1(map) (0) 44 #endif 45 46 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_2 47 # ifdef map_bankwidth 48 # undef map_bankwidth 49 # define map_bankwidth(map) ((map)->bankwidth) 50 # else 51 # define map_bankwidth(map) 2 52 # define map_bankwidth_is_large(map) (0) 53 # define map_words(map) (1) 54 # endif 55 #define map_bankwidth_is_2(map) (map_bankwidth(map) == 2) 56 #undef MAX_MAP_BANKWIDTH 57 #define MAX_MAP_BANKWIDTH 2 58 #else 59 #define map_bankwidth_is_2(map) (0) 60 #endif 61 62 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_4 63 # ifdef map_bankwidth 64 # undef map_bankwidth 65 # define map_bankwidth(map) ((map)->bankwidth) 66 # else 67 # define map_bankwidth(map) 4 68 # define map_bankwidth_is_large(map) (0) 69 # define map_words(map) (1) 70 # endif 71 #define map_bankwidth_is_4(map) (map_bankwidth(map) == 4) 72 #undef MAX_MAP_BANKWIDTH 73 #define MAX_MAP_BANKWIDTH 4 74 #else 75 #define map_bankwidth_is_4(map) (0) 76 #endif 77 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) */ 80 81 #define map_calc_words(map) ((map_bankwidth(map) + (sizeof(unsigned long)-1))/ sizeof(unsigned long)) 82 83 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_8 84 # ifdef map_bankwidth 85 # undef map_bankwidth 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) 90 # undef map_words 91 # define map_words(map) map_calc_words(map) 92 # endif 93 # else 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) 97 # endif 98 #define map_bankwidth_is_8(map) (map_bankwidth(map) == 8) 99 #undef MAX_MAP_BANKWIDTH 100 #define MAX_MAP_BANKWIDTH 8 101 #else 102 #define map_bankwidth_is_8(map) (0) 103 #endif 104 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) 111 # undef map_words 112 # define map_words(map) map_calc_words(map) 113 # else 114 # define map_bankwidth(map) 16 115 # define map_bankwidth_is_large(map) (1) 116 # define map_words(map) map_calc_words(map) 117 # endif 118 #define map_bankwidth_is_16(map) (map_bankwidth(map) == 16) 119 #undef MAX_MAP_BANKWIDTH 120 #define MAX_MAP_BANKWIDTH 16 121 #else 122 #define map_bankwidth_is_16(map) (0) 123 #endif 124 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) 131 # undef map_words 132 # define map_words(map) map_calc_words(map) 133 # else 134 # define map_bankwidth(map) 32 135 # define map_bankwidth_is_large(map) (1) 136 # define map_words(map) map_calc_words(map) 137 # endif 138 #define map_bankwidth_is_32(map) (map_bankwidth(map) == 32) 139 #undef MAX_MAP_BANKWIDTH 140 #define MAX_MAP_BANKWIDTH 32 141 #else 142 #define map_bankwidth_is_32(map) (0) 143 #endif 144 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) 148 { 149 BUG(); 150 return 0; 151 } 152 #define map_bankwidth_is_large(map) (0) 153 #define map_words(map) (0) 154 #define MAX_MAP_BANKWIDTH 1 155 #endif 156 157 static inline int map_bankwidth_supported(int w) 158 { 159 switch (w) { 160 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_1 161 case 1: 162 #endif 163 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_2 164 case 2: 165 #endif 166 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_4 167 case 4: 168 #endif 169 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_8 170 case 8: 171 #endif 172 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_16 173 case 16: 174 #endif 175 #ifdef CONFIG_MTD_MAP_BANK_WIDTH_32 176 case 32: 177 #endif 178 return 1; 179 180 default: 181 return 0; 182 } 183 } 184 185 #define MAX_MAP_LONGS ( ((MAX_MAP_BANKWIDTH*8) + BITS_PER_LONG - 1) / BITS_PER_LONG ) 186 187 typedef union { 188 unsigned long x[MAX_MAP_LONGS]; 189 } map_word; 190 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 200 use; whatever. 201 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 206 of living. 207 */ 208 209 struct map_info { 210 const char *name; 211 unsigned long size; 212 resource_size_t phys; 213 #define NO_XIP (-1UL) 214 215 void __iomem *virt; 216 void *cached; 217 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 241 /* set_vpp() must handle being reentered -- enable, enable, disable 242 must leave it enabled. */ 243 void (*set_vpp)(struct map_info *, int); 244 245 unsigned long pfow_base; 246 unsigned long map_priv_1; 247 unsigned long map_priv_2; 248 void *fldrv_priv; 249 struct mtd_chip_driver *fldrv; 250 }; 251 252 struct mtd_chip_driver { 253 struct mtd_info *(*probe)(struct map_info *map); 254 void (*destroy)(struct mtd_info *); 255 struct module *module; 256 char *name; 257 struct list_head list; 258 }; 259 260 void register_mtd_chip_driver(struct mtd_chip_driver *); 261 void unregister_mtd_chip_driver(struct mtd_chip_driver *); 262 263 struct mtd_info *do_map_probe(const char *name, struct map_info *map); 264 void map_destroy(struct mtd_info *mtd); 265 266 #define ENABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 1); } while(0) 267 #define DISABLE_VPP(map) do { if(map->set_vpp) map->set_vpp(map, 0); } while(0) 268 269 #define INVALIDATE_CACHED_RANGE(map, from, size) \ 270 do { if(map->inval_cache) map->inval_cache(map, from, size); } while(0) 271 272 273 static inline int map_word_equal(struct map_info *map, map_word val1, map_word val2) 274 { 275 int i; 276 for (i=0; i<map_words(map); i++) { 277 if (val1.x[i] != val2.x[i]) 278 return 0; 279 } 280 return 1; 281 } 282 283 static inline map_word map_word_and(struct map_info *map, map_word val1, map_word val2) 284 { 285 map_word r; 286 int i; 287 288 for (i=0; i<map_words(map); i++) { 289 r.x[i] = val1.x[i] & val2.x[i]; 290 } 291 return r; 292 } 293 294 static inline map_word map_word_clr(struct map_info *map, map_word val1, map_word val2) 295 { 296 map_word r; 297 int i; 298 299 for (i=0; i<map_words(map); i++) { 300 r.x[i] = val1.x[i] & ~val2.x[i]; 301 } 302 return r; 303 } 304 305 static inline map_word map_word_or(struct map_info *map, map_word val1, map_word val2) 306 { 307 map_word r; 308 int i; 309 310 for (i=0; i<map_words(map); i++) { 311 r.x[i] = val1.x[i] | val2.x[i]; 312 } 313 return r; 314 } 315 316 #define map_word_andequal(m, a, b, z) map_word_equal(m, z, map_word_and(m, a, b)) 317 318 static inline int map_word_bitsset(struct map_info *map, map_word val1, map_word val2) 319 { 320 int i; 321 322 for (i=0; i<map_words(map); i++) { 323 if (val1.x[i] & val2.x[i]) 324 return 1; 325 } 326 return 0; 327 } 328 329 static inline map_word map_word_load(struct map_info *map, const void *ptr) 330 { 331 map_word r; 332 333 if (map_bankwidth_is_1(map)) 334 r.x[0] = *(unsigned char *)ptr; 335 else if (map_bankwidth_is_2(map)) 336 r.x[0] = get_unaligned((uint16_t *)ptr); 337 else if (map_bankwidth_is_4(map)) 338 r.x[0] = get_unaligned((uint32_t *)ptr); 339 #if BITS_PER_LONG >= 64 340 else if (map_bankwidth_is_8(map)) 341 r.x[0] = get_unaligned((uint64_t *)ptr); 342 #endif 343 else if (map_bankwidth_is_large(map)) 344 memcpy(r.x, ptr, map->bankwidth); 345 346 return r; 347 } 348 349 static inline map_word map_word_load_partial(struct map_info *map, map_word orig, const unsigned char *buf, int start, int len) 350 { 351 int i; 352 353 if (map_bankwidth_is_large(map)) { 354 char *dest = (char *)&orig; 355 memcpy(dest+start, buf, len); 356 } else { 357 for (i=start; i < start+len; i++) { 358 int bitpos; 359 #ifdef __LITTLE_ENDIAN 360 bitpos = i*8; 361 #else /* __BIG_ENDIAN */ 362 bitpos = (map_bankwidth(map)-1-i)*8; 363 #endif 364 orig.x[0] &= ~(0xff << bitpos); 365 orig.x[0] |= buf[i-start] << bitpos; 366 } 367 } 368 return orig; 369 } 370 371 #if BITS_PER_LONG < 64 372 #define MAP_FF_LIMIT 4 373 #else 374 #define MAP_FF_LIMIT 8 375 #endif 376 377 static inline map_word map_word_ff(struct map_info *map) 378 { 379 map_word r; 380 int i; 381 382 if (map_bankwidth(map) < MAP_FF_LIMIT) { 383 int bw = 8 * map_bankwidth(map); 384 r.x[0] = (1 << bw) - 1; 385 } else { 386 for (i=0; i<map_words(map); i++) 387 r.x[i] = ~0UL; 388 } 389 return r; 390 } 391 392 static inline map_word inline_map_read(struct map_info *map, unsigned long ofs) 393 { 394 map_word r; 395 396 if (map_bankwidth_is_1(map)) 397 r.x[0] = __raw_readb(map->virt + ofs); 398 else if (map_bankwidth_is_2(map)) 399 r.x[0] = __raw_readw(map->virt + ofs); 400 else if (map_bankwidth_is_4(map)) 401 r.x[0] = __raw_readl(map->virt + ofs); 402 #if BITS_PER_LONG >= 64 403 else if (map_bankwidth_is_8(map)) 404 r.x[0] = __raw_readq(map->virt + ofs); 405 #endif 406 else if (map_bankwidth_is_large(map)) 407 memcpy_fromio(r.x, map->virt+ofs, map->bankwidth); 408 else 409 BUG(); 410 411 return r; 412 } 413 414 static inline void inline_map_write(struct map_info *map, const map_word datum, unsigned long ofs) 415 { 416 if (map_bankwidth_is_1(map)) 417 __raw_writeb(datum.x[0], map->virt + ofs); 418 else if (map_bankwidth_is_2(map)) 419 __raw_writew(datum.x[0], map->virt + ofs); 420 else if (map_bankwidth_is_4(map)) 421 __raw_writel(datum.x[0], map->virt + ofs); 422 #if BITS_PER_LONG >= 64 423 else if (map_bankwidth_is_8(map)) 424 __raw_writeq(datum.x[0], map->virt + ofs); 425 #endif 426 else if (map_bankwidth_is_large(map)) 427 memcpy_toio(map->virt+ofs, datum.x, map->bankwidth); 428 mb(); 429 } 430 431 static inline void inline_map_copy_from(struct map_info *map, void *to, unsigned long from, ssize_t len) 432 { 433 if (map->cached) 434 memcpy(to, (char *)map->cached + from, len); 435 else 436 memcpy_fromio(to, map->virt + from, len); 437 } 438 439 static inline void inline_map_copy_to(struct map_info *map, unsigned long to, const void *from, ssize_t len) 440 { 441 memcpy_toio(map->virt + to, from, len); 442 } 443 444 #ifdef CONFIG_MTD_COMPLEX_MAPPINGS 445 #define map_read(map, ofs) (map)->read(map, ofs) 446 #define map_copy_from(map, to, from, len) (map)->copy_from(map, to, from, len) 447 #define map_write(map, datum, ofs) (map)->write(map, datum, ofs) 448 #define map_copy_to(map, to, from, len) (map)->copy_to(map, to, from, len) 449 450 extern void simple_map_init(struct map_info *); 451 #define map_is_linear(map) (map->phys != NO_XIP) 452 453 #else 454 #define map_read(map, ofs) inline_map_read(map, ofs) 455 #define map_copy_from(map, to, from, len) inline_map_copy_from(map, to, from, len) 456 #define map_write(map, datum, ofs) inline_map_write(map, datum, ofs) 457 #define map_copy_to(map, to, from, len) inline_map_copy_to(map, to, from, len) 458 459 460 #define simple_map_init(map) BUG_ON(!map_bankwidth_supported((map)->bankwidth)) 461 #define map_is_linear(map) ({ (void)(map); 1; }) 462 463 #endif /* !CONFIG_MTD_COMPLEX_MAPPINGS */ 464 465 #endif /* __LINUX_MTD_MAP_H__ */ 466