Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 1 | /* |
David Woodhouse | a1452a3 | 2010-08-08 20:58:20 +0100 | [diff] [blame] | 2 | * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | * |
David Woodhouse | a1452a3 | 2010-08-08 20:58:20 +0100 | [diff] [blame] | 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 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | */ |
| 19 | |
| 20 | #ifndef __MTD_MTD_H__ |
| 21 | #define __MTD_MTD_H__ |
| 22 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | #include <linux/types.h> |
| 24 | #include <linux/module.h> |
| 25 | #include <linux/uio.h> |
Nicolas Pitre | 963a6fb | 2005-04-01 02:59:56 +0100 | [diff] [blame] | 26 | #include <linux/notifier.h> |
David Brownell | 1f24b5a | 2009-03-26 00:42:41 -0700 | [diff] [blame] | 27 | #include <linux/device.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | #include <mtd/mtd-abi.h> |
| 30 | |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 31 | #include <asm/div64.h> |
| 32 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | #define MTD_CHAR_MAJOR 90 |
| 34 | #define MTD_BLOCK_MAJOR 31 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | |
Brian Norris | e2e24e8 | 2011-08-23 17:17:36 -0700 | [diff] [blame] | 36 | #define MTD_ERASE_PENDING 0x01 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | #define MTD_ERASING 0x02 |
| 38 | #define MTD_ERASE_SUSPEND 0x04 |
Brian Norris | e2e24e8 | 2011-08-23 17:17:36 -0700 | [diff] [blame] | 39 | #define MTD_ERASE_DONE 0x08 |
| 40 | #define MTD_ERASE_FAILED 0x10 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 42 | #define MTD_FAIL_ADDR_UNKNOWN -1LL |
Adrian Hunter | bb0eb21 | 2008-08-12 12:40:50 +0300 | [diff] [blame] | 43 | |
Brian Norris | e2e24e8 | 2011-08-23 17:17:36 -0700 | [diff] [blame] | 44 | /* |
| 45 | * If the erase fails, fail_addr might indicate exactly which block failed. If |
| 46 | * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level |
| 47 | * or was not specific to any particular block. |
| 48 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | struct erase_info { |
| 50 | struct mtd_info *mtd; |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 51 | uint64_t addr; |
| 52 | uint64_t len; |
| 53 | uint64_t fail_addr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | u_long time; |
| 55 | u_long retries; |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 56 | unsigned dev; |
| 57 | unsigned cell; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | void (*callback) (struct erase_info *self); |
| 59 | u_long priv; |
| 60 | u_char state; |
| 61 | struct erase_info *next; |
| 62 | }; |
| 63 | |
| 64 | struct mtd_erase_region_info { |
Brian Norris | e2e24e8 | 2011-08-23 17:17:36 -0700 | [diff] [blame] | 65 | uint64_t offset; /* At which this region starts, from the beginning of the MTD */ |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 66 | uint32_t erasesize; /* For this region */ |
| 67 | uint32_t numblocks; /* Number of blocks of erasesize in this region */ |
Rodolfo Giometti | 0ecbc81 | 2007-03-26 21:45:43 -0800 | [diff] [blame] | 68 | unsigned long *lockmap; /* If keeping bitmap of locks */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | }; |
| 70 | |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 71 | /** |
| 72 | * struct mtd_oob_ops - oob operation operands |
| 73 | * @mode: operation mode |
| 74 | * |
Vitaly Wool | 7014568 | 2006-11-03 18:20:38 +0300 | [diff] [blame] | 75 | * @len: number of data bytes to write/read |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 76 | * |
Vitaly Wool | 7014568 | 2006-11-03 18:20:38 +0300 | [diff] [blame] | 77 | * @retlen: number of data bytes written/read |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 78 | * |
Vitaly Wool | 7014568 | 2006-11-03 18:20:38 +0300 | [diff] [blame] | 79 | * @ooblen: number of oob bytes to write/read |
| 80 | * @oobretlen: number of oob bytes written/read |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 81 | * @ooboffs: offset of oob data in the oob area (only relevant when |
Brian Norris | 4180f24 | 2011-08-30 18:45:44 -0700 | [diff] [blame] | 82 | * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW) |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 83 | * @datbuf: data buffer - if NULL only oob data are read/written |
| 84 | * @oobbuf: oob data buffer |
Artem Bityutskiy | 73a4421 | 2007-01-31 11:43:13 +0200 | [diff] [blame] | 85 | * |
Frederik Schwarzer | 025dfda | 2008-10-16 19:02:37 +0200 | [diff] [blame] | 86 | * Note, it is allowed to read more than one OOB area at one go, but not write. |
Artem Bityutskiy | 73a4421 | 2007-01-31 11:43:13 +0200 | [diff] [blame] | 87 | * The interface assumes that the OOB write requests program only one page's |
| 88 | * OOB area. |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 89 | */ |
| 90 | struct mtd_oob_ops { |
Brian Norris | 905c6bc | 2011-08-30 18:45:39 -0700 | [diff] [blame] | 91 | unsigned int mode; |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 92 | size_t len; |
| 93 | size_t retlen; |
| 94 | size_t ooblen; |
Vitaly Wool | 7014568 | 2006-11-03 18:20:38 +0300 | [diff] [blame] | 95 | size_t oobretlen; |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 96 | uint32_t ooboffs; |
| 97 | uint8_t *datbuf; |
| 98 | uint8_t *oobbuf; |
| 99 | }; |
| 100 | |
Brian Norris | cc26c3c | 2010-08-24 18:12:00 -0700 | [diff] [blame] | 101 | #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32 |
| 102 | #define MTD_MAX_ECCPOS_ENTRIES_LARGE 448 |
Brian Norris | cc26c3c | 2010-08-24 18:12:00 -0700 | [diff] [blame] | 103 | /* |
Brian Norris | 0ceacf3 | 2010-09-19 23:57:12 -0700 | [diff] [blame] | 104 | * Internal ECC layout control structure. For historical reasons, there is a |
| 105 | * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained |
| 106 | * for export to user-space via the ECCGETLAYOUT ioctl. |
| 107 | * nand_ecclayout should be expandable in the future simply by the above macros. |
Brian Norris | cc26c3c | 2010-08-24 18:12:00 -0700 | [diff] [blame] | 108 | */ |
| 109 | struct nand_ecclayout { |
| 110 | __u32 eccbytes; |
| 111 | __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE]; |
| 112 | __u32 oobavail; |
| 113 | struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE]; |
| 114 | }; |
| 115 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | struct mtd_info { |
| 117 | u_char type; |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 118 | uint32_t flags; |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 119 | uint64_t size; // Total size of the MTD |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | |
David Woodhouse | 151e765 | 2006-05-14 01:51:54 +0100 | [diff] [blame] | 121 | /* "Major" erase size for the device. Naïve users may take this |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | * to be the only erase size available, or may use the more detailed |
| 123 | * information below if they desire |
| 124 | */ |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 125 | uint32_t erasesize; |
Artem B. Bityutskiy | 783ed81 | 2006-06-14 19:53:44 +0400 | [diff] [blame] | 126 | /* Minimal writable flash unit size. In case of NOR flash it is 1 (even |
| 127 | * though individual bits can be cleared), in case of NAND flash it is |
| 128 | * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR |
| 129 | * it is of ECC block size, etc. It is illegal to have writesize = 0. |
| 130 | * Any driver registering a struct mtd_info must ensure a writesize of |
| 131 | * 1 or larger. |
Joern Engel | 2831877 | 2006-05-22 23:18:05 +0200 | [diff] [blame] | 132 | */ |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 133 | uint32_t writesize; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | |
Anatolij Gustschin | 0e4ca7e | 2010-12-16 23:42:14 +0100 | [diff] [blame] | 135 | /* |
| 136 | * Size of the write buffer used by the MTD. MTD devices having a write |
| 137 | * buffer can write multiple writesize chunks at a time. E.g. while |
| 138 | * writing 4 * writesize bytes to a device with 2 * writesize bytes |
| 139 | * buffer the MTD driver can (but doesn't have to) do 2 writesize |
| 140 | * operations, but not 4. Currently, all NANDs have writebufsize |
| 141 | * equivalent to writesize (NAND page size). Some NOR flashes do have |
| 142 | * writebufsize greater than writesize. |
| 143 | */ |
| 144 | uint32_t writebufsize; |
| 145 | |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 146 | uint32_t oobsize; // Amount of OOB data per block (e.g. 16) |
| 147 | uint32_t oobavail; // Available OOB bytes per block |
Nicolas Pitre | 638d983 | 2005-08-06 05:40:46 +0100 | [diff] [blame] | 148 | |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 149 | /* |
| 150 | * If erasesize is a power of 2 then the shift is stored in |
| 151 | * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize. |
| 152 | */ |
| 153 | unsigned int erasesize_shift; |
| 154 | unsigned int writesize_shift; |
| 155 | /* Masks based on erasesize_shift and writesize_shift */ |
| 156 | unsigned int erasesize_mask; |
| 157 | unsigned int writesize_mask; |
Nicolas Pitre | 638d983 | 2005-08-06 05:40:46 +0100 | [diff] [blame] | 158 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | // Kernel-only stuff starts here. |
Greg Kroah-Hartman | eadcf0d | 2008-07-02 12:46:22 -0700 | [diff] [blame] | 160 | const char *name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | int index; |
| 162 | |
Brian Norris | 7854d3f | 2011-06-23 14:12:08 -0700 | [diff] [blame] | 163 | /* ECC layout structure pointer - read only! */ |
Thomas Gleixner | 5bd34c0 | 2006-05-27 22:16:10 +0200 | [diff] [blame] | 164 | struct nand_ecclayout *ecclayout; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | |
| 166 | /* Data for variable erase regions. If numeraseregions is zero, |
Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 167 | * it means that the whole device has erasesize as given above. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | */ |
| 169 | int numeraseregions; |
Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 170 | struct mtd_erase_region_info *eraseregions; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | |
Jörn Engel | b38178e | 2007-09-21 15:41:44 +0200 | [diff] [blame] | 172 | /* |
| 173 | * Erase is an asynchronous operation. Device drivers are supposed |
| 174 | * to call instr->callback() whenever the operation completes, even |
| 175 | * if it completes with a failure. |
| 176 | * Callers are supposed to pass a callback function and wait for it |
| 177 | * to be called before writing to the block. |
| 178 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 179 | int (*erase) (struct mtd_info *mtd, struct erase_info *instr); |
| 180 | |
| 181 | /* This stuff for eXecute-In-Place */ |
Jared Hulbert | a98889f | 2008-04-29 23:26:49 -0700 | [diff] [blame] | 182 | /* phys is optional and may be set to NULL */ |
| 183 | int (*point) (struct mtd_info *mtd, loff_t from, size_t len, |
| 184 | size_t *retlen, void **virt, resource_size_t *phys); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | |
| 186 | /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ |
Jared Hulbert | a98889f | 2008-04-29 23:26:49 -0700 | [diff] [blame] | 187 | void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | |
David Howells | 402d326 | 2009-02-12 10:40:00 +0000 | [diff] [blame] | 189 | /* Allow NOMMU mmap() to directly map the device (if not NULL) |
| 190 | * - return the address to which the offset maps |
| 191 | * - return -ENOSYS to indicate refusal to do the mapping |
| 192 | */ |
| 193 | unsigned long (*get_unmapped_area) (struct mtd_info *mtd, |
| 194 | unsigned long len, |
| 195 | unsigned long offset, |
| 196 | unsigned long flags); |
| 197 | |
| 198 | /* Backing device capabilities for this device |
| 199 | * - provides mmap capabilities |
| 200 | */ |
| 201 | struct backing_dev_info *backing_dev_info; |
| 202 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | |
| 204 | int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
| 205 | int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); |
| 206 | |
Richard Purdie | 388bbb0 | 2008-02-06 10:17:15 +0000 | [diff] [blame] | 207 | /* In blackbox flight recorder like scenarios we want to make successful |
| 208 | writes in interrupt context. panic_write() is only intended to be |
| 209 | called when its known the kernel is about to panic and we need the |
| 210 | write to succeed. Since the kernel is not going to be running for much |
| 211 | longer, this function can break locks and delay to ensure the write |
| 212 | succeeds (but not sleep). */ |
| 213 | |
| 214 | int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); |
| 215 | |
Thomas Gleixner | 8593fbc | 2006-05-29 03:26:58 +0200 | [diff] [blame] | 216 | int (*read_oob) (struct mtd_info *mtd, loff_t from, |
| 217 | struct mtd_oob_ops *ops); |
| 218 | int (*write_oob) (struct mtd_info *mtd, loff_t to, |
| 219 | struct mtd_oob_ops *ops); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 220 | |
Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 221 | /* |
| 222 | * Methods to access the protection register area, present in some |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | * flash devices. The user data is one time programmable but the |
Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 224 | * factory data is read only. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | */ |
Nicolas Pitre | f77814d | 2005-02-08 17:11:19 +0000 | [diff] [blame] | 226 | int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
Nicolas Pitre | f77814d | 2005-02-08 17:11:19 +0000 | [diff] [blame] | 228 | int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
| 229 | int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
Nicolas Pitre | f77814d | 2005-02-08 17:11:19 +0000 | [diff] [blame] | 231 | int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | |
Thomas Gleixner | 2528e8c | 2006-05-23 16:10:00 +0200 | [diff] [blame] | 233 | /* kvec-based read/write methods. |
Thomas Gleixner | 61ecfa8 | 2005-11-07 11:15:31 +0000 | [diff] [blame] | 234 | NB: The 'count' parameter is the number of _vectors_, each of |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | which contains an (ofs, len) tuple. |
| 236 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 237 | int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 238 | |
| 239 | /* Sync */ |
| 240 | void (*sync) (struct mtd_info *mtd); |
| 241 | |
| 242 | /* Chip-supported device locking */ |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 243 | int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); |
| 244 | int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); |
Richard Cochran | 9938424 | 2010-06-14 18:10:33 +0200 | [diff] [blame] | 245 | int (*is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 246 | |
| 247 | /* Power Management functions */ |
| 248 | int (*suspend) (struct mtd_info *mtd); |
| 249 | void (*resume) (struct mtd_info *mtd); |
| 250 | |
| 251 | /* Bad block management functions */ |
| 252 | int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); |
| 253 | int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); |
| 254 | |
Nicolas Pitre | 963a6fb | 2005-04-01 02:59:56 +0100 | [diff] [blame] | 255 | struct notifier_block reboot_notifier; /* default mode before reboot */ |
| 256 | |
Thomas Gleixner | 7fac464 | 2006-05-25 09:57:31 +0200 | [diff] [blame] | 257 | /* ECC status information */ |
| 258 | struct mtd_ecc_stats ecc_stats; |
Thomas Gleixner | 29072b9 | 2006-09-28 15:38:36 +0200 | [diff] [blame] | 259 | /* Subpage shift (NAND) */ |
| 260 | int subpage_sft; |
Thomas Gleixner | 7fac464 | 2006-05-25 09:57:31 +0200 | [diff] [blame] | 261 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 262 | void *priv; |
| 263 | |
| 264 | struct module *owner; |
David Brownell | 1f24b5a | 2009-03-26 00:42:41 -0700 | [diff] [blame] | 265 | struct device dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 266 | int usecount; |
Artem Bityutskiy | 9fe912c | 2006-10-11 14:52:45 +0300 | [diff] [blame] | 267 | |
| 268 | /* If the driver is something smart, like UBI, it may need to maintain |
| 269 | * its own reference counting. The below functions are only for driver. |
| 270 | * The driver may register its callbacks. These callbacks are not |
| 271 | * supposed to be called by MTD users */ |
| 272 | int (*get_device) (struct mtd_info *mtd); |
| 273 | void (*put_device) (struct mtd_info *mtd); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | }; |
| 275 | |
David Brownell | 1f24b5a | 2009-03-26 00:42:41 -0700 | [diff] [blame] | 276 | static inline struct mtd_info *dev_to_mtd(struct device *dev) |
| 277 | { |
Saeed Bishara | 6afc4fd | 2009-07-28 04:56:43 -0700 | [diff] [blame] | 278 | return dev ? dev_get_drvdata(dev) : NULL; |
David Brownell | 1f24b5a | 2009-03-26 00:42:41 -0700 | [diff] [blame] | 279 | } |
| 280 | |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 281 | static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd) |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 282 | { |
| 283 | if (mtd->erasesize_shift) |
| 284 | return sz >> mtd->erasesize_shift; |
| 285 | do_div(sz, mtd->erasesize); |
| 286 | return sz; |
| 287 | } |
| 288 | |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 289 | static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd) |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 290 | { |
| 291 | if (mtd->erasesize_shift) |
| 292 | return sz & mtd->erasesize_mask; |
| 293 | return do_div(sz, mtd->erasesize); |
| 294 | } |
| 295 | |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 296 | static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd) |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 297 | { |
| 298 | if (mtd->writesize_shift) |
| 299 | return sz >> mtd->writesize_shift; |
| 300 | do_div(sz, mtd->writesize); |
| 301 | return sz; |
| 302 | } |
| 303 | |
David Woodhouse | 26cdb67 | 2008-12-10 14:08:12 +0000 | [diff] [blame] | 304 | static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd) |
Adrian Hunter | 69423d9 | 2008-12-10 13:37:21 +0000 | [diff] [blame] | 305 | { |
| 306 | if (mtd->writesize_shift) |
| 307 | return sz & mtd->writesize_mask; |
| 308 | return do_div(sz, mtd->writesize); |
| 309 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 310 | |
| 311 | /* Kernel-side ioctl definitions */ |
| 312 | |
Jamie Iles | f5671ab | 2011-05-23 17:15:46 +0100 | [diff] [blame] | 313 | struct mtd_partition; |
Dmitry Eremin-Solenikov | c797533 | 2011-06-10 18:18:28 +0400 | [diff] [blame] | 314 | struct mtd_part_parser_data; |
Jamie Iles | f5671ab | 2011-05-23 17:15:46 +0100 | [diff] [blame] | 315 | |
Dmitry Eremin-Solenikov | 1c4c215 | 2011-03-25 22:26:25 +0300 | [diff] [blame] | 316 | extern int mtd_device_parse_register(struct mtd_info *mtd, |
| 317 | const char **part_probe_types, |
Dmitry Eremin-Solenikov | c797533 | 2011-06-10 18:18:28 +0400 | [diff] [blame] | 318 | struct mtd_part_parser_data *parser_data, |
Dmitry Eremin-Solenikov | 1c4c215 | 2011-03-25 22:26:25 +0300 | [diff] [blame] | 319 | const struct mtd_partition *defparts, |
| 320 | int defnr_parts); |
Dmitry Eremin-Solenikov | 15c60a5 | 2011-06-23 15:33:15 +0400 | [diff] [blame] | 321 | #define mtd_device_register(master, parts, nr_parts) \ |
| 322 | mtd_device_parse_register(master, NULL, NULL, parts, nr_parts) |
Jamie Iles | f5671ab | 2011-05-23 17:15:46 +0100 | [diff] [blame] | 323 | extern int mtd_device_unregister(struct mtd_info *master); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 324 | extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); |
Maxim Levitsky | 3bd4565 | 2010-02-22 20:39:28 +0200 | [diff] [blame] | 325 | extern int __get_mtd_device(struct mtd_info *mtd); |
| 326 | extern void __put_mtd_device(struct mtd_info *mtd); |
Artem Bityutskiy | 7799308 | 2006-10-11 14:52:44 +0300 | [diff] [blame] | 327 | extern struct mtd_info *get_mtd_device_nm(const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 328 | extern void put_mtd_device(struct mtd_info *mtd); |
| 329 | |
| 330 | |
| 331 | struct mtd_notifier { |
| 332 | void (*add)(struct mtd_info *mtd); |
| 333 | void (*remove)(struct mtd_info *mtd); |
| 334 | struct list_head list; |
| 335 | }; |
| 336 | |
| 337 | |
| 338 | extern void register_mtd_user (struct mtd_notifier *new); |
| 339 | extern int unregister_mtd_user (struct mtd_notifier *old); |
| 340 | |
| 341 | int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, |
| 342 | unsigned long count, loff_t to, size_t *retlen); |
| 343 | |
| 344 | int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs, |
| 345 | unsigned long count, loff_t from, size_t *retlen); |
| 346 | |
Grant Erickson | 33b5371 | 2011-04-08 08:51:32 -0700 | [diff] [blame] | 347 | void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size); |
| 348 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 349 | void mtd_erase_callback(struct erase_info *instr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 350 | |
Brian Norris | 7387ce7 | 2011-09-20 18:30:51 -0700 | [diff] [blame^] | 351 | static inline int mtd_is_bitflip(int err) { |
| 352 | return err == -EUCLEAN; |
| 353 | } |
| 354 | |
| 355 | static inline int mtd_is_eccerr(int err) { |
| 356 | return err == -EBADMSG; |
| 357 | } |
| 358 | |
| 359 | static inline int mtd_is_bitflip_or_eccerr(int err) { |
| 360 | return mtd_is_bitflip(err) || mtd_is_eccerr(err); |
| 361 | } |
| 362 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 363 | #endif /* __MTD_MTD_H__ */ |