Blame view
drivers/mtd/mtdblock.c
9.77 KB
97894cda5
|
1 |
/* |
1da177e4c
|
2 3 |
* Direct MTD block device access * |
a1452a377
|
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
* Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> * Copyright © 2000-2003 Nicolas Pitre <nico@fluxnic.net> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * |
1da177e4c
|
21 |
*/ |
1da177e4c
|
22 23 |
#include <linux/fs.h> #include <linux/init.h> |
15fdc52f3
|
24 25 26 |
#include <linux/kernel.h> #include <linux/module.h> #include <linux/sched.h> |
1da177e4c
|
27 |
#include <linux/slab.h> |
15fdc52f3
|
28 |
#include <linux/types.h> |
1da177e4c
|
29 |
#include <linux/vmalloc.h> |
15fdc52f3
|
30 |
|
1da177e4c
|
31 32 |
#include <linux/mtd/mtd.h> #include <linux/mtd/blktrans.h> |
48b192686
|
33 |
#include <linux/mutex.h> |
1da177e4c
|
34 |
|
cbfe93e9c
|
35 36 |
struct mtdblk_dev { struct mtd_blktrans_dev mbd; |
1da177e4c
|
37 |
int count; |
48b192686
|
38 |
struct mutex cache_mutex; |
1da177e4c
|
39 40 41 42 |
unsigned char *cache_data; unsigned long cache_offset; unsigned int cache_size; enum { STATE_EMPTY, STATE_CLEAN, STATE_DIRTY } cache_state; |
cbfe93e9c
|
43 |
}; |
1da177e4c
|
44 |
|
7578ca927
|
45 |
static DEFINE_MUTEX(mtdblks_lock); |
d676c1172
|
46 |
|
1da177e4c
|
47 48 |
/* * Cache stuff... |
97894cda5
|
49 |
* |
1da177e4c
|
50 51 52 53 54 55 56 57 58 59 60 61 |
* Since typical flash erasable sectors are much larger than what Linux's * buffer cache can handle, we must implement read-modify-write on flash * sectors for each block write requests. To avoid over-erasing flash sectors * and to speed things up, we locally cache a whole flash sector while it is * being written to until a different sector is required. */ static void erase_callback(struct erase_info *done) { wait_queue_head_t *wait_q = (wait_queue_head_t *)done->priv; wake_up(wait_q); } |
97894cda5
|
62 |
static int erase_write (struct mtd_info *mtd, unsigned long pos, |
1da177e4c
|
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
int len, const char *buf) { struct erase_info erase; DECLARE_WAITQUEUE(wait, current); wait_queue_head_t wait_q; size_t retlen; int ret; /* * First, let's erase the flash block. */ init_waitqueue_head(&wait_q); erase.mtd = mtd; erase.callback = erase_callback; erase.addr = pos; erase.len = len; erase.priv = (u_long)&wait_q; set_current_state(TASK_INTERRUPTIBLE); add_wait_queue(&wait_q, &wait); |
7e1f0dc05
|
84 |
ret = mtd_erase(mtd, &erase); |
1da177e4c
|
85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
if (ret) { set_current_state(TASK_RUNNING); remove_wait_queue(&wait_q, &wait); printk (KERN_WARNING "mtdblock: erase of region [0x%lx, 0x%x] " "on \"%s\" failed ", pos, len, mtd->name); return ret; } schedule(); /* Wait for erase to finish. */ remove_wait_queue(&wait_q, &wait); /* |
dff155098
|
99 |
* Next, write the data to flash. |
1da177e4c
|
100 |
*/ |
eda95cbf7
|
101 |
ret = mtd_write(mtd, pos, len, &retlen, buf); |
1da177e4c
|
102 103 104 105 106 107 108 109 110 111 |
if (ret) return ret; if (retlen != len) return -EIO; return 0; } static int write_cached_data (struct mtdblk_dev *mtdblk) { |
cbfe93e9c
|
112 |
struct mtd_info *mtd = mtdblk->mbd.mtd; |
1da177e4c
|
113 114 115 116 |
int ret; if (mtdblk->cache_state != STATE_DIRTY) return 0; |
289c05222
|
117 |
pr_debug("mtdblock: writing cached data for \"%s\" " |
97894cda5
|
118 119 |
"at 0x%lx, size 0x%x ", mtd->name, |
1da177e4c
|
120 |
mtdblk->cache_offset, mtdblk->cache_size); |
97894cda5
|
121 122 |
ret = erase_write (mtd, mtdblk->cache_offset, |
1da177e4c
|
123 124 125 126 127 |
mtdblk->cache_size, mtdblk->cache_data); if (ret) return ret; /* |
25985edce
|
128 |
* Here we could arguably set the cache state to STATE_CLEAN. |
97894cda5
|
129 130 |
* However this could lead to inconsistency since we will not * be notified if this content is altered on the flash by other |
1da177e4c
|
131 132 133 134 135 136 |
* means. Let's declare it empty and leave buffering tasks to * the buffer cache instead. */ mtdblk->cache_state = STATE_EMPTY; return 0; } |
97894cda5
|
137 |
static int do_cached_write (struct mtdblk_dev *mtdblk, unsigned long pos, |
1da177e4c
|
138 139 |
int len, const char *buf) { |
cbfe93e9c
|
140 |
struct mtd_info *mtd = mtdblk->mbd.mtd; |
1da177e4c
|
141 142 143 |
unsigned int sect_size = mtdblk->cache_size; size_t retlen; int ret; |
289c05222
|
144 145 |
pr_debug("mtdblock: write on \"%s\" at 0x%lx, size 0x%x ", |
1da177e4c
|
146 |
mtd->name, pos, len); |
97894cda5
|
147 |
|
1da177e4c
|
148 |
if (!sect_size) |
eda95cbf7
|
149 |
return mtd_write(mtd, pos, len, &retlen, buf); |
1da177e4c
|
150 151 152 153 154 |
while (len > 0) { unsigned long sect_start = (pos/sect_size)*sect_size; unsigned int offset = pos - sect_start; unsigned int size = sect_size - offset; |
97894cda5
|
155 |
if( size > len ) |
1da177e4c
|
156 157 158 |
size = len; if (size == sect_size) { |
97894cda5
|
159 |
/* |
1da177e4c
|
160 161 162 163 164 165 166 167 168 169 170 171 172 |
* We are covering a whole sector. Thus there is no * need to bother with the cache while it may still be * useful for other partial writes. */ ret = erase_write (mtd, pos, size, buf); if (ret) return ret; } else { /* Partial sector: need to use the cache */ if (mtdblk->cache_state == STATE_DIRTY && mtdblk->cache_offset != sect_start) { ret = write_cached_data(mtdblk); |
97894cda5
|
173 |
if (ret) |
1da177e4c
|
174 175 176 177 178 179 180 |
return ret; } if (mtdblk->cache_state == STATE_EMPTY || mtdblk->cache_offset != sect_start) { /* fill the cache with the current sector */ mtdblk->cache_state = STATE_EMPTY; |
329ad399a
|
181 182 |
ret = mtd_read(mtd, sect_start, sect_size, &retlen, mtdblk->cache_data); |
1da177e4c
|
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
if (ret) return ret; if (retlen != sect_size) return -EIO; mtdblk->cache_offset = sect_start; mtdblk->cache_size = sect_size; mtdblk->cache_state = STATE_CLEAN; } /* write data to our local cache */ memcpy (mtdblk->cache_data + offset, buf, size); mtdblk->cache_state = STATE_DIRTY; } buf += size; pos += size; len -= size; } return 0; } |
97894cda5
|
205 |
static int do_cached_read (struct mtdblk_dev *mtdblk, unsigned long pos, |
1da177e4c
|
206 207 |
int len, char *buf) { |
cbfe93e9c
|
208 |
struct mtd_info *mtd = mtdblk->mbd.mtd; |
1da177e4c
|
209 210 211 |
unsigned int sect_size = mtdblk->cache_size; size_t retlen; int ret; |
289c05222
|
212 213 |
pr_debug("mtdblock: read on \"%s\" at 0x%lx, size 0x%x ", |
1da177e4c
|
214 |
mtd->name, pos, len); |
97894cda5
|
215 |
|
1da177e4c
|
216 |
if (!sect_size) |
329ad399a
|
217 |
return mtd_read(mtd, pos, len, &retlen, buf); |
1da177e4c
|
218 219 220 221 222 |
while (len > 0) { unsigned long sect_start = (pos/sect_size)*sect_size; unsigned int offset = pos - sect_start; unsigned int size = sect_size - offset; |
97894cda5
|
223 |
if (size > len) |
1da177e4c
|
224 225 226 227 228 229 230 231 232 233 234 235 |
size = len; /* * Check if the requested data is already cached * Read the requested amount of data from our internal cache if it * contains what we want, otherwise we read the data directly * from flash. */ if (mtdblk->cache_state != STATE_EMPTY && mtdblk->cache_offset == sect_start) { memcpy (buf, mtdblk->cache_data + offset, size); } else { |
329ad399a
|
236 |
ret = mtd_read(mtd, pos, size, &retlen, buf); |
1da177e4c
|
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
if (ret) return ret; if (retlen != size) return -EIO; } buf += size; pos += size; len -= size; } return 0; } static int mtdblock_readsect(struct mtd_blktrans_dev *dev, unsigned long block, char *buf) { |
cbfe93e9c
|
254 |
struct mtdblk_dev *mtdblk = container_of(dev, struct mtdblk_dev, mbd); |
1da177e4c
|
255 256 257 258 259 260 |
return do_cached_read(mtdblk, block<<9, 512, buf); } static int mtdblock_writesect(struct mtd_blktrans_dev *dev, unsigned long block, char *buf) { |
cbfe93e9c
|
261 |
struct mtdblk_dev *mtdblk = container_of(dev, struct mtdblk_dev, mbd); |
1da177e4c
|
262 |
if (unlikely(!mtdblk->cache_data && mtdblk->cache_size)) { |
cbfe93e9c
|
263 |
mtdblk->cache_data = vmalloc(mtdblk->mbd.mtd->erasesize); |
1da177e4c
|
264 265 266 267 268 269 270 271 272 273 274 275 |
if (!mtdblk->cache_data) return -EINTR; /* -EINTR is not really correct, but it is the best match * documented in man 2 write for all cases. We could also * return -EAGAIN sometimes, but why bother? */ } return do_cached_write(mtdblk, block<<9, 512, buf); } static int mtdblock_open(struct mtd_blktrans_dev *mbd) { |
cbfe93e9c
|
276 |
struct mtdblk_dev *mtdblk = container_of(mbd, struct mtdblk_dev, mbd); |
1da177e4c
|
277 |
|
289c05222
|
278 279 |
pr_debug("mtdblock_open "); |
97894cda5
|
280 |
|
d676c1172
|
281 |
mutex_lock(&mtdblks_lock); |
cbfe93e9c
|
282 283 |
if (mtdblk->count) { mtdblk->count++; |
d676c1172
|
284 |
mutex_unlock(&mtdblks_lock); |
1da177e4c
|
285 286 |
return 0; } |
97894cda5
|
287 |
|
1da177e4c
|
288 |
/* OK, it's not open. Create cache info for it */ |
1da177e4c
|
289 |
mtdblk->count = 1; |
48b192686
|
290 |
mutex_init(&mtdblk->cache_mutex); |
1da177e4c
|
291 |
mtdblk->cache_state = STATE_EMPTY; |
cbfe93e9c
|
292 293 |
if (!(mbd->mtd->flags & MTD_NO_ERASE) && mbd->mtd->erasesize) { mtdblk->cache_size = mbd->mtd->erasesize; |
1da177e4c
|
294 295 |
mtdblk->cache_data = NULL; } |
d676c1172
|
296 |
mutex_unlock(&mtdblks_lock); |
97894cda5
|
297 |
|
289c05222
|
298 299 |
pr_debug("ok "); |
1da177e4c
|
300 301 302 303 304 305 |
return 0; } static int mtdblock_release(struct mtd_blktrans_dev *mbd) { |
cbfe93e9c
|
306 |
struct mtdblk_dev *mtdblk = container_of(mbd, struct mtdblk_dev, mbd); |
1da177e4c
|
307 |
|
289c05222
|
308 309 |
pr_debug("mtdblock_release "); |
1da177e4c
|
310 |
|
d676c1172
|
311 |
mutex_lock(&mtdblks_lock); |
48b192686
|
312 |
mutex_lock(&mtdblk->cache_mutex); |
1da177e4c
|
313 |
write_cached_data(mtdblk); |
48b192686
|
314 |
mutex_unlock(&mtdblk->cache_mutex); |
1da177e4c
|
315 316 |
if (!--mtdblk->count) { |
cbfe93e9c
|
317 |
/* It was the last usage. Free the cache */ |
327cf2922
|
318 |
mtd_sync(mbd->mtd); |
1da177e4c
|
319 |
vfree(mtdblk->cache_data); |
1da177e4c
|
320 |
} |
d676c1172
|
321 322 |
mutex_unlock(&mtdblks_lock); |
289c05222
|
323 324 |
pr_debug("ok "); |
1da177e4c
|
325 326 |
return 0; |
97894cda5
|
327 |
} |
1da177e4c
|
328 329 330 |
static int mtdblock_flush(struct mtd_blktrans_dev *dev) { |
cbfe93e9c
|
331 |
struct mtdblk_dev *mtdblk = container_of(dev, struct mtdblk_dev, mbd); |
1da177e4c
|
332 |
|
48b192686
|
333 |
mutex_lock(&mtdblk->cache_mutex); |
1da177e4c
|
334 |
write_cached_data(mtdblk); |
48b192686
|
335 |
mutex_unlock(&mtdblk->cache_mutex); |
327cf2922
|
336 |
mtd_sync(dev->mtd); |
1da177e4c
|
337 338 339 340 341 |
return 0; } static void mtdblock_add_mtd(struct mtd_blktrans_ops *tr, struct mtd_info *mtd) { |
cbfe93e9c
|
342 |
struct mtdblk_dev *dev = kzalloc(sizeof(*dev), GFP_KERNEL); |
1da177e4c
|
343 344 345 |
if (!dev) return; |
cbfe93e9c
|
346 347 |
dev->mbd.mtd = mtd; dev->mbd.devnum = mtd->index; |
191876729
|
348 |
|
cbfe93e9c
|
349 350 |
dev->mbd.size = mtd->size >> 9; dev->mbd.tr = tr; |
1da177e4c
|
351 352 |
if (!(mtd->flags & MTD_WRITEABLE)) |
cbfe93e9c
|
353 |
dev->mbd.readonly = 1; |
1da177e4c
|
354 |
|
298304f1a
|
355 356 |
if (add_mtd_blktrans_dev(&dev->mbd)) kfree(dev); |
1da177e4c
|
357 358 359 360 361 |
} static void mtdblock_remove_dev(struct mtd_blktrans_dev *dev) { del_mtd_blktrans_dev(dev); |
1da177e4c
|
362 363 364 365 366 367 |
} static struct mtd_blktrans_ops mtdblock_tr = { .name = "mtdblock", .major = 31, .part_bits = 0, |
191876729
|
368 |
.blksize = 512, |
1da177e4c
|
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
.open = mtdblock_open, .flush = mtdblock_flush, .release = mtdblock_release, .readsect = mtdblock_readsect, .writesect = mtdblock_writesect, .add_mtd = mtdblock_add_mtd, .remove_dev = mtdblock_remove_dev, .owner = THIS_MODULE, }; static int __init init_mtdblock(void) { return register_mtd_blktrans(&mtdblock_tr); } static void __exit cleanup_mtdblock(void) { deregister_mtd_blktrans(&mtdblock_tr); } module_init(init_mtdblock); module_exit(cleanup_mtdblock); MODULE_LICENSE("GPL"); |
2f82af08f
|
394 |
MODULE_AUTHOR("Nicolas Pitre <nico@fluxnic.net> et al."); |
1da177e4c
|
395 |
MODULE_DESCRIPTION("Caching read/erase/writeback block device emulation access to MTD devices"); |