mtd-abi.h 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. /*
  2. * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
  3. *
  4. * SPDX-License-Identifier: GPL-2.0+
  5. *
  6. */
  7. #ifndef __MTD_ABI_H__
  8. #define __MTD_ABI_H__
  9. #ifdef __UBOOT__
  10. #include <linux/compat.h>
  11. #endif
  12. #include <linux/compiler.h>
  13. struct erase_info_user {
  14. __u32 start;
  15. __u32 length;
  16. };
  17. struct erase_info_user64 {
  18. __u64 start;
  19. __u64 length;
  20. };
  21. struct mtd_oob_buf {
  22. __u32 start;
  23. __u32 length;
  24. unsigned char __user *ptr;
  25. };
  26. struct mtd_oob_buf64 {
  27. __u64 start;
  28. __u32 pad;
  29. __u32 length;
  30. __u64 usr_ptr;
  31. };
  32. /**
  33. * MTD operation modes
  34. *
  35. * @MTD_OPS_PLACE_OOB: OOB data are placed at the given offset (default)
  36. * @MTD_OPS_AUTO_OOB: OOB data are automatically placed at the free areas
  37. * which are defined by the internal ecclayout
  38. * @MTD_OPS_RAW: data are transferred as-is, with no error correction;
  39. * this mode implies %MTD_OPS_PLACE_OOB
  40. *
  41. * These modes can be passed to ioctl(MEMWRITE) and are also used internally.
  42. * See notes on "MTD file modes" for discussion on %MTD_OPS_RAW vs.
  43. * %MTD_FILE_MODE_RAW.
  44. */
  45. enum {
  46. MTD_OPS_PLACE_OOB = 0,
  47. MTD_OPS_AUTO_OOB = 1,
  48. MTD_OPS_RAW = 2,
  49. };
  50. /**
  51. * struct mtd_write_req - data structure for requesting a write operation
  52. *
  53. * @start: start address
  54. * @len: length of data buffer
  55. * @ooblen: length of OOB buffer
  56. * @usr_data: user-provided data buffer
  57. * @usr_oob: user-provided OOB buffer
  58. * @mode: MTD mode (see "MTD operation modes")
  59. * @padding: reserved, must be set to 0
  60. *
  61. * This structure supports ioctl(MEMWRITE) operations, allowing data and/or OOB
  62. * writes in various modes. To write to OOB-only, set @usr_data == NULL, and to
  63. * write data-only, set @usr_oob == NULL. However, setting both @usr_data and
  64. * @usr_oob to NULL is not allowed.
  65. */
  66. struct mtd_write_req {
  67. __u64 start;
  68. __u64 len;
  69. __u64 ooblen;
  70. __u64 usr_data;
  71. __u64 usr_oob;
  72. __u8 mode;
  73. __u8 padding[7];
  74. };
  75. #define MTD_ABSENT 0
  76. #define MTD_RAM 1
  77. #define MTD_ROM 2
  78. #define MTD_NORFLASH 3
  79. #define MTD_NANDFLASH 4 /* SLC NAND */
  80. #define MTD_DATAFLASH 6
  81. #define MTD_UBIVOLUME 7
  82. #define MTD_MLCNANDFLASH 8 /* MLC NAND (including TLC) */
  83. #define MTD_WRITEABLE 0x400 /* Device is writeable */
  84. #define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
  85. #define MTD_NO_ERASE 0x1000 /* No erase necessary */
  86. #define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
  87. /* Some common devices / combinations of capabilities */
  88. #define MTD_CAP_ROM 0
  89. #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
  90. #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
  91. #define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
  92. /* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */
  93. #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
  94. #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
  95. #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
  96. #define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
  97. #define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
  98. /* OTP mode selection */
  99. #define MTD_OTP_OFF 0
  100. #define MTD_OTP_FACTORY 1
  101. #define MTD_OTP_USER 2
  102. struct mtd_info_user {
  103. __u8 type;
  104. __u32 flags;
  105. __u32 size; /* Total size of the MTD */
  106. __u32 erasesize;
  107. __u32 writesize;
  108. __u32 oobsize; /* Amount of OOB data per block (e.g. 16) */
  109. __u64 padding; /* Old obsolete field; do not use */
  110. };
  111. struct region_info_user {
  112. __u32 offset; /* At which this region starts,
  113. * from the beginning of the MTD */
  114. __u32 erasesize; /* For this region */
  115. __u32 numblocks; /* Number of blocks in this region */
  116. __u32 regionindex;
  117. };
  118. struct otp_info {
  119. __u32 start;
  120. __u32 length;
  121. __u32 locked;
  122. };
  123. /*
  124. * Note, the following ioctl existed in the past and was removed:
  125. * #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
  126. * Try to avoid adding a new ioctl with the same ioctl number.
  127. */
  128. /* Get basic MTD characteristics info (better to use sysfs) */
  129. #define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
  130. /* Erase segment of MTD */
  131. #define MEMERASE _IOW('M', 2, struct erase_info_user)
  132. /* Write out-of-band data from MTD */
  133. #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
  134. /* Read out-of-band data from MTD */
  135. #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
  136. /* Lock a chip (for MTD that supports it) */
  137. #define MEMLOCK _IOW('M', 5, struct erase_info_user)
  138. /* Unlock a chip (for MTD that supports it) */
  139. #define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
  140. /* Get the number of different erase regions */
  141. #define MEMGETREGIONCOUNT _IOR('M', 7, int)
  142. /* Get information about the erase region for a specific index */
  143. #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
  144. /* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */
  145. #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
  146. /* Check if an eraseblock is bad */
  147. #define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
  148. /* Mark an eraseblock as bad */
  149. #define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
  150. /* Set OTP (One-Time Programmable) mode (factory vs. user) */
  151. #define OTPSELECT _IOR('M', 13, int)
  152. /* Get number of OTP (One-Time Programmable) regions */
  153. #define OTPGETREGIONCOUNT _IOW('M', 14, int)
  154. /* Get all OTP (One-Time Programmable) info about MTD */
  155. #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
  156. /* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
  157. #define OTPLOCK _IOR('M', 16, struct otp_info)
  158. /* Get ECC layout (deprecated) */
  159. #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
  160. /* Get statistics about corrected/uncorrected errors */
  161. #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
  162. /* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */
  163. #define MTDFILEMODE _IO('M', 19)
  164. /* Erase segment of MTD (supports 64-bit address) */
  165. #define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
  166. /* Write data to OOB (64-bit version) */
  167. #define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
  168. /* Read data from OOB (64-bit version) */
  169. #define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
  170. /* Check if chip is locked (for MTD that supports it) */
  171. #define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
  172. /*
  173. * Most generic write interface; can write in-band and/or out-of-band in various
  174. * modes (see "struct mtd_write_req"). This ioctl is not supported for flashes
  175. * without OOB, e.g., NOR flash.
  176. */
  177. #define MEMWRITE _IOWR('M', 24, struct mtd_write_req)
  178. /*
  179. * Obsolete legacy interface. Keep it in order not to break userspace
  180. * interfaces
  181. */
  182. struct nand_oobinfo {
  183. __u32 useecc;
  184. __u32 eccbytes;
  185. __u32 oobfree[8][2];
  186. __u32 eccpos[32];
  187. };
  188. struct nand_oobfree {
  189. __u32 offset;
  190. __u32 length;
  191. };
  192. #define MTD_MAX_OOBFREE_ENTRIES 8
  193. #define MTD_MAX_ECCPOS_ENTRIES 64
  194. /*
  195. * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
  196. * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
  197. * complete set of ECC information. The ioctl truncates the larger internal
  198. * structure to retain binary compatibility with the static declaration of the
  199. * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
  200. * the user struct, not the MAX size of the internal struct nand_ecclayout.
  201. */
  202. struct nand_ecclayout_user {
  203. __u32 eccbytes;
  204. __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
  205. __u32 oobavail;
  206. struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
  207. };
  208. /**
  209. * struct mtd_ecc_stats - error correction stats
  210. *
  211. * @corrected: number of corrected bits
  212. * @failed: number of uncorrectable errors
  213. * @badblocks: number of bad blocks in this partition
  214. * @bbtblocks: number of blocks reserved for bad block tables
  215. */
  216. struct mtd_ecc_stats {
  217. __u32 corrected;
  218. __u32 failed;
  219. __u32 badblocks;
  220. __u32 bbtblocks;
  221. };
  222. /*
  223. * MTD file modes - for read/write access to MTD
  224. *
  225. * @MTD_FILE_MODE_NORMAL: OTP disabled, ECC enabled
  226. * @MTD_FILE_MODE_OTP_FACTORY: OTP enabled in factory mode
  227. * @MTD_FILE_MODE_OTP_USER: OTP enabled in user mode
  228. * @MTD_FILE_MODE_RAW: OTP disabled, ECC disabled
  229. *
  230. * These modes can be set via ioctl(MTDFILEMODE). The mode mode will be retained
  231. * separately for each open file descriptor.
  232. *
  233. * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW -
  234. * raw access to the flash, without error correction or autoplacement schemes.
  235. * Wherever possible, the MTD_OPS_* mode will override the MTD_FILE_MODE_* mode
  236. * (e.g., when using ioctl(MEMWRITE)), but in some cases, the MTD_FILE_MODE is
  237. * used out of necessity (e.g., `write()', ioctl(MEMWRITEOOB64)).
  238. */
  239. enum mtd_file_modes {
  240. MTD_FILE_MODE_NORMAL = MTD_OTP_OFF,
  241. MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
  242. MTD_FILE_MODE_OTP_USER = MTD_OTP_USER,
  243. MTD_FILE_MODE_RAW,
  244. };
  245. static inline int mtd_type_is_nand_user(const struct mtd_info_user *mtd)
  246. {
  247. return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
  248. }
  249. #endif /* __MTD_ABI_H__ */