2 * PS3 FLASH ROM Storage Driver
4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
5 * Copyright 2007 Sony Corp.
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <linux/miscdevice.h>
23 #include <linux/slab.h>
24 #include <linux/uaccess.h>
25 #include <linux/module.h>
27 #include <asm/lv1call.h>
28 #include <asm/ps3stor.h>
31 #define DEVICE_NAME "ps3flash"
33 #define FLASH_BLOCK_SIZE (256*1024)
36 struct ps3flash_private {
37 struct mutex mutex; /* Bounce buffer mutex */
39 int tag; /* Start sector of buffer, -1 if invalid */
43 static struct ps3_storage_device *ps3flash_dev;
45 static int ps3flash_read_write_sectors(struct ps3_storage_device *dev,
46 u64 start_sector, int write)
48 struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
49 u64 res = ps3stor_read_write_sectors(dev, dev->bounce_lpar,
50 start_sector, priv->chunk_sectors,
53 dev_err(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
54 __LINE__, write ? "write" : "read", res);
60 static int ps3flash_writeback(struct ps3_storage_device *dev)
62 struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
65 if (!priv->dirty || priv->tag < 0)
68 res = ps3flash_read_write_sectors(dev, priv->tag, 1);
76 static int ps3flash_fetch(struct ps3_storage_device *dev, u64 start_sector)
78 struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
81 if (start_sector == priv->tag)
84 res = ps3flash_writeback(dev);
90 res = ps3flash_read_write_sectors(dev, start_sector, 0);
94 priv->tag = start_sector;
98 static loff_t ps3flash_llseek(struct file *file, loff_t offset, int origin)
100 struct ps3_storage_device *dev = ps3flash_dev;
101 return generic_file_llseek_size(file, offset, origin, MAX_LFS_FILESIZE,
102 dev->regions[dev->region_idx].size*dev->blk_size);
105 static ssize_t ps3flash_read(char __user *userbuf, void *kernelbuf,
106 size_t count, loff_t *pos)
108 struct ps3_storage_device *dev = ps3flash_dev;
109 struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
110 u64 size, sector, offset;
115 dev_dbg(&dev->sbd.core,
116 "%s:%u: Reading %zu bytes at position %lld to U0x%p/K0x%p\n",
117 __func__, __LINE__, count, *pos, userbuf, kernelbuf);
119 size = dev->regions[dev->region_idx].size*dev->blk_size;
120 if (*pos >= size || !count)
123 if (*pos + count > size) {
124 dev_dbg(&dev->sbd.core,
125 "%s:%u Truncating count from %zu to %llu\n", __func__,
126 __LINE__, count, size - *pos);
130 sector = *pos / dev->bounce_size * priv->chunk_sectors;
131 offset = *pos % dev->bounce_size;
135 n = min_t(u64, remaining, dev->bounce_size - offset);
136 src = dev->bounce_buf + offset;
138 mutex_lock(&priv->mutex);
140 res = ps3flash_fetch(dev, sector);
144 dev_dbg(&dev->sbd.core,
145 "%s:%u: copy %lu bytes from 0x%p to U0x%p/K0x%p\n",
146 __func__, __LINE__, n, src, userbuf, kernelbuf);
148 if (copy_to_user(userbuf, src, n)) {
155 memcpy(kernelbuf, src, n);
159 mutex_unlock(&priv->mutex);
163 sector += priv->chunk_sectors;
165 } while (remaining > 0);
170 mutex_unlock(&priv->mutex);
174 static ssize_t ps3flash_write(const char __user *userbuf,
175 const void *kernelbuf, size_t count, loff_t *pos)
177 struct ps3_storage_device *dev = ps3flash_dev;
178 struct ps3flash_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
179 u64 size, sector, offset;
184 dev_dbg(&dev->sbd.core,
185 "%s:%u: Writing %zu bytes at position %lld from U0x%p/K0x%p\n",
186 __func__, __LINE__, count, *pos, userbuf, kernelbuf);
188 size = dev->regions[dev->region_idx].size*dev->blk_size;
189 if (*pos >= size || !count)
192 if (*pos + count > size) {
193 dev_dbg(&dev->sbd.core,
194 "%s:%u Truncating count from %zu to %llu\n", __func__,
195 __LINE__, count, size - *pos);
199 sector = *pos / dev->bounce_size * priv->chunk_sectors;
200 offset = *pos % dev->bounce_size;
204 n = min_t(u64, remaining, dev->bounce_size - offset);
205 dst = dev->bounce_buf + offset;
207 mutex_lock(&priv->mutex);
209 if (n != dev->bounce_size)
210 res = ps3flash_fetch(dev, sector);
211 else if (sector != priv->tag)
212 res = ps3flash_writeback(dev);
216 dev_dbg(&dev->sbd.core,
217 "%s:%u: copy %lu bytes from U0x%p/K0x%p to 0x%p\n",
218 __func__, __LINE__, n, userbuf, kernelbuf, dst);
220 if (copy_from_user(dst, userbuf, n)) {
227 memcpy(dst, kernelbuf, n);
234 mutex_unlock(&priv->mutex);
238 sector += priv->chunk_sectors;
240 } while (remaining > 0);
245 mutex_unlock(&priv->mutex);
249 static ssize_t ps3flash_user_read(struct file *file, char __user *buf,
250 size_t count, loff_t *pos)
252 return ps3flash_read(buf, NULL, count, pos);
255 static ssize_t ps3flash_user_write(struct file *file, const char __user *buf,
256 size_t count, loff_t *pos)
258 return ps3flash_write(buf, NULL, count, pos);
261 static ssize_t ps3flash_kernel_read(void *buf, size_t count, loff_t pos)
263 return ps3flash_read(NULL, buf, count, &pos);
266 static ssize_t ps3flash_kernel_write(const void *buf, size_t count,
272 res = ps3flash_write(NULL, buf, count, &pos);
276 /* Make kernel writes synchronous */
277 wb = ps3flash_writeback(ps3flash_dev);
284 static int ps3flash_flush(struct file *file, fl_owner_t id)
286 return ps3flash_writeback(ps3flash_dev);
289 static int ps3flash_fsync(struct file *file, loff_t start, loff_t end, int datasync)
291 struct inode *inode = file_inode(file);
293 mutex_lock(&inode->i_mutex);
294 err = ps3flash_writeback(ps3flash_dev);
295 mutex_unlock(&inode->i_mutex);
299 static irqreturn_t ps3flash_interrupt(int irq, void *data)
301 struct ps3_storage_device *dev = data;
305 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
308 dev_err(&dev->sbd.core,
309 "%s:%u: tag mismatch, got %llx, expected %llx\n",
310 __func__, __LINE__, tag, dev->tag);
313 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
314 __func__, __LINE__, res, status);
316 dev->lv1_status = status;
317 complete(&dev->done);
322 static const struct file_operations ps3flash_fops = {
323 .owner = THIS_MODULE,
324 .llseek = ps3flash_llseek,
325 .read = ps3flash_user_read,
326 .write = ps3flash_user_write,
327 .flush = ps3flash_flush,
328 .fsync = ps3flash_fsync,
331 static const struct ps3_os_area_flash_ops ps3flash_kernel_ops = {
332 .read = ps3flash_kernel_read,
333 .write = ps3flash_kernel_write,
336 static struct miscdevice ps3flash_misc = {
337 .minor = MISC_DYNAMIC_MINOR,
339 .fops = &ps3flash_fops,
342 static int ps3flash_probe(struct ps3_system_bus_device *_dev)
344 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
345 struct ps3flash_private *priv;
349 tmp = dev->regions[dev->region_idx].start*dev->blk_size;
350 if (tmp % FLASH_BLOCK_SIZE) {
351 dev_err(&dev->sbd.core,
352 "%s:%u region start %lu is not aligned\n", __func__,
356 tmp = dev->regions[dev->region_idx].size*dev->blk_size;
357 if (tmp % FLASH_BLOCK_SIZE) {
358 dev_err(&dev->sbd.core,
359 "%s:%u region size %lu is not aligned\n", __func__,
364 /* use static buffer, kmalloc cannot allocate 256 KiB */
365 if (!ps3flash_bounce_buffer.address)
369 dev_err(&dev->sbd.core,
370 "Only one FLASH device is supported\n");
376 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
382 ps3_system_bus_set_drvdata(&dev->sbd, priv);
383 mutex_init(&priv->mutex);
386 dev->bounce_size = ps3flash_bounce_buffer.size;
387 dev->bounce_buf = ps3flash_bounce_buffer.address;
388 priv->chunk_sectors = dev->bounce_size / dev->blk_size;
390 error = ps3stor_setup(dev, ps3flash_interrupt);
394 ps3flash_misc.parent = &dev->sbd.core;
395 error = misc_register(&ps3flash_misc);
397 dev_err(&dev->sbd.core, "%s:%u: misc_register failed %d\n",
398 __func__, __LINE__, error);
402 dev_info(&dev->sbd.core, "%s:%u: registered misc device %d\n",
403 __func__, __LINE__, ps3flash_misc.minor);
405 ps3_os_area_flash_register(&ps3flash_kernel_ops);
409 ps3stor_teardown(dev);
412 ps3_system_bus_set_drvdata(&dev->sbd, NULL);
418 static int ps3flash_remove(struct ps3_system_bus_device *_dev)
420 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
422 ps3_os_area_flash_register(NULL);
423 misc_deregister(&ps3flash_misc);
424 ps3stor_teardown(dev);
425 kfree(ps3_system_bus_get_drvdata(&dev->sbd));
426 ps3_system_bus_set_drvdata(&dev->sbd, NULL);
432 static struct ps3_system_bus_driver ps3flash = {
433 .match_id = PS3_MATCH_ID_STOR_FLASH,
434 .core.name = DEVICE_NAME,
435 .core.owner = THIS_MODULE,
436 .probe = ps3flash_probe,
437 .remove = ps3flash_remove,
438 .shutdown = ps3flash_remove,
442 static int __init ps3flash_init(void)
444 return ps3_system_bus_driver_register(&ps3flash);
447 static void __exit ps3flash_exit(void)
449 ps3_system_bus_driver_unregister(&ps3flash);
452 module_init(ps3flash_init);
453 module_exit(ps3flash_exit);
455 MODULE_LICENSE("GPL");
456 MODULE_DESCRIPTION("PS3 FLASH ROM Storage Driver");
457 MODULE_AUTHOR("Sony Corporation");
458 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_FLASH);