mtd.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:8k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /* $Id: mtd.h,v 1.33 2001/06/09 00:08:59 dwmw2 Exp $ */
  2. #ifndef __MTD_MTD_H__
  3. #define __MTD_MTD_H__
  4. #ifdef __KERNEL__
  5. #include <linux/config.h>
  6. #include <linux/version.h>
  7. #include <linux/types.h>
  8. #include <linux/mtd/compatmac.h>
  9. #include <linux/module.h>
  10. #include <linux/uio.h>
  11. #endif /* __KERNEL__ */
  12. struct erase_info_user {
  13. u_int32_t start;
  14. u_int32_t length;
  15. };
  16. struct mtd_oob_buf {
  17. u_int32_t start;
  18. u_int32_t length;
  19. unsigned char *ptr;
  20. };
  21. #define MTD_CHAR_MAJOR 90
  22. #define MTD_BLOCK_MAJOR 31
  23. #define MAX_MTD_DEVICES 16
  24. #define MTD_ABSENT 0
  25. #define MTD_RAM 1
  26. #define MTD_ROM 2
  27. #define MTD_NORFLASH 3
  28. #define MTD_NANDFLASH 4
  29. #define MTD_PEROM 5
  30. #define MTD_OTHER 14
  31. #define MTD_UNKNOWN 15
  32. #define MTD_CLEAR_BITS 1       // Bits can be cleared (flash)
  33. #define MTD_SET_BITS 2       // Bits can be set
  34. #define MTD_ERASEABLE 4       // Has an erase function
  35. #define MTD_WRITEB_WRITEABLE 8       // Direct IO is possible
  36. #define MTD_VOLATILE 16      // Set for RAMs
  37. #define MTD_XIP 32 // eXecute-In-Place possible
  38. #define MTD_OOB 64 // Out-of-band data (NAND flash)
  39. #define MTD_ECC 128 // Device capable of automatic ECC
  40. // Some common devices / combinations of capabilities
  41. #define MTD_CAP_ROM 0
  42. #define MTD_CAP_RAM (MTD_CLEAR_BITS|MTD_SET_BITS|MTD_WRITEB_WRITEABLE)
  43. #define MTD_CAP_NORFLASH        (MTD_CLEAR_BITS|MTD_ERASEABLE)
  44. #define MTD_CAP_NANDFLASH       (MTD_CLEAR_BITS|MTD_ERASEABLE|MTD_OOB)
  45. #define MTD_WRITEABLE (MTD_CLEAR_BITS|MTD_SET_BITS)
  46. // Types of automatic ECC/Checksum available
  47. #define MTD_ECC_NONE 0  // No automatic ECC available
  48. #define MTD_ECC_RS_DiskOnChip 1 // Automatic ECC on DiskOnChip
  49. #define MTD_ECC_SW 2 // SW ECC for Toshiba & Samsung devices
  50. struct mtd_info_user {
  51. u_char type;
  52. u_int32_t flags;
  53. u_int32_t size;  // Total size of the MTD
  54. u_int32_t erasesize;
  55. u_int32_t oobblock;  // Size of OOB blocks (e.g. 512)
  56. u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
  57. u_int32_t ecctype;
  58. u_int32_t eccsize;
  59. };
  60. struct region_info_user {
  61. u_int32_t offset; /* At which this region starts, 
  62.  * from the beginning of the MTD */
  63. u_int32_t erasesize; /* For this region */
  64. u_int32_t numblocks; /* Number of blocks in this region */
  65. u_int32_t regionindex;
  66. };
  67. #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
  68. #define MEMERASE                _IOW('M', 2, struct erase_info_user)
  69. #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
  70. #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
  71. #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
  72. #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
  73. #define MEMGETREGIONCOUNT _IOR('M', 7, int)
  74. #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
  75. #ifndef __KERNEL__
  76. typedef struct mtd_info_user mtd_info_t;
  77. typedef struct erase_info_user erase_info_t;
  78. typedef struct region_info_user region_info_t;
  79. /* User-space ioctl definitions */
  80. #else /* __KERNEL__ */
  81. #define MTD_ERASE_PENDING       0x01
  82. #define MTD_ERASING 0x02
  83. #define MTD_ERASE_SUSPEND 0x04
  84. #define MTD_ERASE_DONE          0x08
  85. #define MTD_ERASE_FAILED        0x10
  86. struct erase_info {
  87. struct mtd_info *mtd;
  88. u_int32_t addr;
  89. u_int32_t len;
  90. u_long time;
  91. u_long retries;
  92. u_int dev;
  93. u_int cell;
  94. void (*callback) (struct erase_info *self);
  95. u_long priv;
  96. u_char state;
  97. struct erase_info *next;
  98. };
  99. struct mtd_erase_region_info {
  100. u_int32_t offset; /* At which this region starts, from the beginning of the MTD */
  101. u_int32_t erasesize; /* For this region */
  102. u_int32_t numblocks; /* Number of blocks of erasesize in this region */
  103. };
  104. struct mtd_info {
  105. u_char type;
  106. u_int32_t flags;
  107. u_int32_t size;  // Total size of the MTD
  108. /* "Major" erase size for the device. Na飗e users may take this
  109.  * to be the only erase size available, or may use the more detailed
  110.  * information below if they desire
  111.  */
  112. u_int32_t erasesize;
  113. u_int32_t oobblock;  // Size of OOB blocks (e.g. 512)
  114. u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
  115. u_int32_t ecctype;
  116. u_int32_t eccsize;
  117. // Kernel-only stuff starts here.
  118. char *name;
  119. int index;
  120. /* Data for variable erase regions. If numeraseregions is zero,
  121.  * it means that the whole device has erasesize as given above. 
  122.  */
  123. int numeraseregions;
  124. struct mtd_erase_region_info *eraseregions; 
  125. /* This really shouldn't be here. It can go away in 2.5 */
  126. u_int32_t bank_size;
  127. struct module *module;
  128. int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
  129. /* This stuff for eXecute-In-Place */
  130. int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
  131. /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
  132. void (*unpoint) (struct mtd_info *mtd, u_char * addr);
  133. int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  134. int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
  135. int (*read_ecc) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf, u_char *eccbuf);
  136. int (*write_ecc) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf, u_char *eccbuf);
  137. int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  138. int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
  139. /* iovec-based read/write methods. We need these especially for NAND flash,
  140.    with its limited number of write cycles per erase.
  141.    NB: The 'count' parameter is the number of _vectors_, each of 
  142.    which contains an (ofs, len) tuple.
  143. */
  144. int (*readv) (struct mtd_info *mtd, struct iovec *vecs, unsigned long count, loff_t from, size_t *retlen);
  145. int (*writev) (struct mtd_info *mtd, const struct iovec *vecs, unsigned long count, loff_t to, size_t *retlen);
  146. /* Sync */
  147. void (*sync) (struct mtd_info *mtd);
  148. /* Chip-supported device locking */
  149. int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  150. int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  151. /* Power Management functions */
  152. int (*suspend) (struct mtd_info *mtd);
  153. void (*resume) (struct mtd_info *mtd);
  154. void *priv;
  155. };
  156. /* Kernel-side ioctl definitions */
  157. extern int add_mtd_device(struct mtd_info *mtd);
  158. extern int del_mtd_device (struct mtd_info *mtd);
  159. extern struct mtd_info *__get_mtd_device(struct mtd_info *mtd, int num);
  160. static inline struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
  161. {
  162. struct mtd_info *ret;
  163. ret = __get_mtd_device(mtd, num);
  164. if (ret && ret->module && !try_inc_mod_count(ret->module))
  165. return NULL;
  166. return ret;
  167. }
  168. static inline void put_mtd_device(struct mtd_info *mtd)
  169. {
  170.        if (mtd->module)
  171.        __MOD_DEC_USE_COUNT(mtd->module);
  172. }
  173. struct mtd_notifier {
  174. void (*add)(struct mtd_info *mtd);
  175. void (*remove)(struct mtd_info *mtd);
  176. struct mtd_notifier *next;
  177. };
  178. extern void register_mtd_user (struct mtd_notifier *new);
  179. extern int unregister_mtd_user (struct mtd_notifier *old);
  180. #ifndef MTDC
  181. #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
  182. #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
  183. #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
  184. #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
  185. #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
  186. #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
  187. #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
  188. #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
  189. #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
  190. #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
  191. #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
  192. #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd);  } while (0) 
  193. #endif /* MTDC */
  194. /*
  195.  * Debugging macro and defines
  196.  */
  197. #define MTD_DEBUG_LEVEL0 (0) /* Quiet   */
  198. #define MTD_DEBUG_LEVEL1 (1) /* Audible */
  199. #define MTD_DEBUG_LEVEL2 (2) /* Loud    */
  200. #define MTD_DEBUG_LEVEL3 (3) /* Noisy   */
  201. #ifdef CONFIG_MTD_DEBUG
  202. #define DEBUG(n, args...)
  203. if (n <=  CONFIG_MTD_DEBUG_VERBOSE) {
  204. printk(KERN_INFO args);
  205. }
  206. #else /* CONFIG_MTD_DEBUG */
  207. #define DEBUG(n, args...)
  208. #endif /* CONFIG_MTD_DEBUG */
  209. #endif /* __KERNEL__ */
  210. #endif /* __MTD_MTD_H__ */