mtd.h 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. /*
  2. * $Id: mtd.h,v 1.1.1.1 2007/06/12 07:27:16 eyryu Exp $
  3. *
  4. * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
  5. *
  6. * Released under GPL
  7. */
  8. #ifndef __MTD_MTD_H__
  9. #define __MTD_MTD_H__
  10. #ifndef __KERNEL__
  11. #error This is a kernel header. Perhaps include mtd-user.h instead?
  12. #endif
  13. #include <linux/types.h>
  14. #include <linux/module.h>
  15. #include <linux/uio.h>
  16. #include <linux/notifier.h>
  17. #include <linux/mtd/compatmac.h>
  18. #include <mtd/mtd-abi.h>
  19. #define MTD_CHAR_MAJOR 90
  20. #define MTD_BLOCK_MAJOR 31
  21. #define MAX_MTD_DEVICES 32
  22. #define MTD_ERASE_PENDING 0x01
  23. #define MTD_ERASING 0x02
  24. #define MTD_ERASE_SUSPEND 0x04
  25. #define MTD_ERASE_DONE 0x08
  26. #define MTD_ERASE_FAILED 0x10
  27. /* If the erase fails, fail_addr might indicate exactly which block failed. If
  28. fail_addr = 0xffffffff, the failure was not at the device level or was not
  29. specific to any particular block. */
  30. struct erase_info {
  31. struct mtd_info *mtd;
  32. u_int32_t addr;
  33. u_int32_t len;
  34. u_int32_t fail_addr;
  35. u_long time;
  36. u_long retries;
  37. u_int dev;
  38. u_int cell;
  39. void (*callback) (struct erase_info *self);
  40. u_long priv;
  41. u_char state;
  42. struct erase_info *next;
  43. };
  44. struct mtd_erase_region_info {
  45. u_int32_t offset; /* At which this region starts, from the beginning of the MTD */
  46. u_int32_t erasesize; /* For this region */
  47. u_int32_t numblocks; /* Number of blocks of erasesize in this region */
  48. };
  49. /*
  50. * oob operation modes
  51. *
  52. * MTD_OOB_PLACE: oob data are placed at the given offset
  53. * MTD_OOB_AUTO: oob data are automatically placed at the free areas
  54. * which are defined by the ecclayout
  55. * MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data
  56. * is inserted into the data. Thats a raw image of the
  57. * flash contents.
  58. */
  59. typedef enum {
  60. MTD_OOB_PLACE,
  61. MTD_OOB_AUTO,
  62. MTD_OOB_RAW,
  63. } mtd_oob_mode_t;
  64. /**
  65. * struct mtd_oob_ops - oob operation operands
  66. * @mode: operation mode
  67. *
  68. * @len: number of data bytes to write/read
  69. *
  70. * @retlen: number of data bytes written/read
  71. *
  72. * @ooblen: number of oob bytes to write/read
  73. * @oobretlen: number of oob bytes written/read
  74. * @ooboffs: offset of oob data in the oob area (only relevant when
  75. * mode = MTD_OOB_PLACE)
  76. * @datbuf: data buffer - if NULL only oob data are read/written
  77. * @oobbuf: oob data buffer
  78. *
  79. * Note, it is allowed to read more then one OOB area at one go, but not write.
  80. * The interface assumes that the OOB write requests program only one page's
  81. * OOB area.
  82. */
  83. struct mtd_oob_ops {
  84. mtd_oob_mode_t mode;
  85. size_t len;
  86. size_t retlen;
  87. size_t ooblen;
  88. size_t oobretlen;
  89. uint32_t ooboffs;
  90. uint8_t *datbuf;
  91. uint8_t *oobbuf;
  92. };
  93. struct mtd_info {
  94. u_char type;
  95. u_int32_t flags;
  96. u_int32_t size; // Total size of the MTD
  97. /* "Major" erase size for the device. Naïve users may take this
  98. * to be the only erase size available, or may use the more detailed
  99. * information below if they desire
  100. */
  101. u_int32_t erasesize;
  102. /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
  103. * though individual bits can be cleared), in case of NAND flash it is
  104. * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
  105. * it is of ECC block size, etc. It is illegal to have writesize = 0.
  106. * Any driver registering a struct mtd_info must ensure a writesize of
  107. * 1 or larger.
  108. */
  109. u_int32_t writesize;
  110. u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
  111. u_int32_t oobavail; // Available OOB bytes per block
  112. // Kernel-only stuff starts here.
  113. char *name;
  114. int index;
  115. /* ecc layout structure pointer - read only ! */
  116. struct nand_ecclayout *ecclayout;
  117. /* Data for variable erase regions. If numeraseregions is zero,
  118. * it means that the whole device has erasesize as given above.
  119. */
  120. int numeraseregions;
  121. struct mtd_erase_region_info *eraseregions;
  122. /* This really shouldn't be here. It can go away in 2.5 */
  123. u_int32_t bank_size;
  124. int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
  125. /* This stuff for eXecute-In-Place */
  126. int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
  127. /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
  128. void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len);
  129. int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  130. int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
  131. int (*read_oob) (struct mtd_info *mtd, loff_t from,
  132. struct mtd_oob_ops *ops);
  133. int (*write_oob) (struct mtd_info *mtd, loff_t to,
  134. struct mtd_oob_ops *ops);
  135. /*
  136. * Methods to access the protection register area, present in some
  137. * flash devices. The user data is one time programmable but the
  138. * factory data is read only.
  139. */
  140. int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
  141. int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  142. int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
  143. int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  144. int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  145. int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
  146. /* kvec-based read/write methods.
  147. NB: The 'count' parameter is the number of _vectors_, each of
  148. which contains an (ofs, len) tuple.
  149. */
  150. int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
  151. /* Sync */
  152. void (*sync) (struct mtd_info *mtd);
  153. /* Chip-supported device locking */
  154. int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  155. int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  156. /* Power Management functions */
  157. int (*suspend) (struct mtd_info *mtd);
  158. void (*resume) (struct mtd_info *mtd);
  159. /* Bad block management functions */
  160. int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
  161. int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
  162. struct notifier_block reboot_notifier; /* default mode before reboot */
  163. /* ECC status information */
  164. struct mtd_ecc_stats ecc_stats;
  165. /* Subpage shift (NAND) */
  166. int subpage_sft;
  167. void *priv;
  168. struct module *owner;
  169. int usecount;
  170. /* If the driver is something smart, like UBI, it may need to maintain
  171. * its own reference counting. The below functions are only for driver.
  172. * The driver may register its callbacks. These callbacks are not
  173. * supposed to be called by MTD users */
  174. int (*get_device) (struct mtd_info *mtd);
  175. void (*put_device) (struct mtd_info *mtd);
  176. };
  177. /* Kernel-side ioctl definitions */
  178. extern int add_mtd_device(struct mtd_info *mtd);
  179. extern int del_mtd_device (struct mtd_info *mtd);
  180. extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
  181. extern struct mtd_info *get_mtd_device_nm(const char *name);
  182. extern void put_mtd_device(struct mtd_info *mtd);
  183. struct mtd_notifier {
  184. void (*add)(struct mtd_info *mtd);
  185. void (*remove)(struct mtd_info *mtd);
  186. struct list_head list;
  187. };
  188. extern void register_mtd_user (struct mtd_notifier *new);
  189. extern int unregister_mtd_user (struct mtd_notifier *old);
  190. int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
  191. unsigned long count, loff_t to, size_t *retlen);
  192. int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
  193. unsigned long count, loff_t from, size_t *retlen);
  194. #ifdef CONFIG_MTD_PARTITIONS
  195. void mtd_erase_callback(struct erase_info *instr);
  196. #else
  197. static inline void mtd_erase_callback(struct erase_info *instr)
  198. {
  199. if (instr->callback)
  200. instr->callback(instr);
  201. }
  202. #endif
  203. /*
  204. * Debugging macro and defines
  205. */
  206. #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
  207. #define MTD_DEBUG_LEVEL1 (1) /* Audible */
  208. #define MTD_DEBUG_LEVEL2 (2) /* Loud */
  209. #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
  210. #ifdef CONFIG_MTD_DEBUG
  211. #define DEBUG(n, args...) \
  212. do { \
  213. if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
  214. printk(KERN_INFO args); \
  215. } while(0)
  216. #else /* CONFIG_MTD_DEBUG */
  217. #define DEBUG(n, args...) do { } while(0)
  218. #endif /* CONFIG_MTD_DEBUG */
  219. #endif /* __MTD_MTD_H__ */