map.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:12k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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