2 * PS3 Disk 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.
21 #include <linux/ata.h>
22 #include <linux/blkdev.h>
23 #include <linux/slab.h>
25 #include <asm/lv1call.h>
26 #include <asm/ps3stor.h>
27 #include <asm/firmware.h>
30 #define DEVICE_NAME "ps3disk"
32 #define BOUNCE_SIZE (64*1024)
34 #define PS3DISK_MAX_DISKS 16
35 #define PS3DISK_MINORS 16
38 #define PS3DISK_NAME "ps3d%c"
41 struct ps3disk_private {
42 spinlock_t lock; /* Request queue spinlock */
43 struct request_queue *queue;
44 struct gendisk *gendisk;
45 unsigned int blocking_factor;
48 unsigned char model[ATA_ID_PROD_LEN+1];
52 #define LV1_STORAGE_SEND_ATA_COMMAND (2)
53 #define LV1_STORAGE_ATA_HDDOUT (0x23)
55 struct lv1_ata_cmnd_block {
73 PIO_DATA_IN_PROTO = 1,
74 PIO_DATA_OUT_PROTO = 2,
79 DIR_WRITE = 0, /* memory -> device */
80 DIR_READ = 1 /* device -> memory */
83 static int ps3disk_major;
86 static const struct block_device_operations ps3disk_fops = {
91 static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
92 struct request *req, int gather)
94 unsigned int offset = 0;
95 struct req_iterator iter;
101 rq_for_each_segment(bvec, req, iter) {
103 dev_dbg(&dev->sbd.core,
104 "%s:%u: bio %u: %u segs %u sectors from %lu\n",
105 __func__, __LINE__, i, bio_segments(iter.bio),
106 bio_sectors(iter.bio), iter.bio->bi_sector);
109 buf = bvec_kmap_irq(bvec, &flags);
111 memcpy(dev->bounce_buf+offset, buf, size);
113 memcpy(buf, dev->bounce_buf+offset, size);
115 flush_kernel_dcache_page(bvec->bv_page);
116 bvec_kunmap_irq(bvec, &flags);
121 static int ps3disk_submit_request_sg(struct ps3_storage_device *dev,
124 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
125 int write = rq_data_dir(req), res;
126 const char *op = write ? "write" : "read";
127 u64 start_sector, sectors;
128 unsigned int region_id = dev->regions[dev->region_idx].id;
133 struct req_iterator iter;
135 rq_for_each_segment(bv, req, iter)
137 dev_dbg(&dev->sbd.core,
138 "%s:%u: %s req has %u bvecs for %u sectors\n",
139 __func__, __LINE__, op, n, blk_rq_sectors(req));
142 start_sector = blk_rq_pos(req) * priv->blocking_factor;
143 sectors = blk_rq_sectors(req) * priv->blocking_factor;
144 dev_dbg(&dev->sbd.core, "%s:%u: %s %llu sectors starting at %llu\n",
145 __func__, __LINE__, op, sectors, start_sector);
148 ps3disk_scatter_gather(dev, req, 1);
150 res = lv1_storage_write(dev->sbd.dev_id, region_id,
151 start_sector, sectors, 0,
152 dev->bounce_lpar, &dev->tag);
154 res = lv1_storage_read(dev->sbd.dev_id, region_id,
155 start_sector, sectors, 0,
156 dev->bounce_lpar, &dev->tag);
159 dev_err(&dev->sbd.core, "%s:%u: %s failed %d\n", __func__,
161 __blk_end_request_all(req, -EIO);
169 static int ps3disk_submit_flush_request(struct ps3_storage_device *dev,
172 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
175 dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
177 res = lv1_storage_send_device_command(dev->sbd.dev_id,
178 LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
181 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
182 __func__, __LINE__, res);
183 __blk_end_request_all(req, -EIO);
191 static void ps3disk_do_request(struct ps3_storage_device *dev,
192 struct request_queue *q)
196 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
198 while ((req = blk_fetch_request(q))) {
199 if (req->cmd_type == REQ_TYPE_FS) {
200 if (ps3disk_submit_request_sg(dev, req))
202 } else if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
203 req->cmd[0] == REQ_LB_OP_FLUSH) {
204 if (ps3disk_submit_flush_request(dev, req))
207 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
208 __blk_end_request_all(req, -EIO);
214 static void ps3disk_request(struct request_queue *q)
216 struct ps3_storage_device *dev = q->queuedata;
217 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
220 dev_dbg(&dev->sbd.core, "%s:%u busy\n", __func__, __LINE__);
224 ps3disk_do_request(dev, q);
227 static irqreturn_t ps3disk_interrupt(int irq, void *data)
229 struct ps3_storage_device *dev = data;
230 struct ps3disk_private *priv;
232 int res, read, error;
236 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
239 dev_err(&dev->sbd.core,
240 "%s:%u: tag mismatch, got %llx, expected %llx\n",
241 __func__, __LINE__, tag, dev->tag);
244 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
245 __func__, __LINE__, res, status);
249 priv = ps3_system_bus_get_drvdata(&dev->sbd);
252 dev_dbg(&dev->sbd.core,
253 "%s:%u non-block layer request completed\n", __func__,
255 dev->lv1_status = status;
256 complete(&dev->done);
260 if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
261 req->cmd[0] == REQ_LB_OP_FLUSH) {
265 read = !rq_data_dir(req);
266 op = read ? "read" : "write";
269 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
270 __LINE__, op, status);
273 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
277 ps3disk_scatter_gather(dev, req, 0);
280 spin_lock(&priv->lock);
281 __blk_end_request_all(req, error);
283 ps3disk_do_request(dev, priv->queue);
284 spin_unlock(&priv->lock);
289 static int ps3disk_sync_cache(struct ps3_storage_device *dev)
293 dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__);
295 res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0);
297 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
298 __func__, __LINE__, res);
305 /* ATA helpers copied from drivers/ata/libata-core.c */
307 static void swap_buf_le16(u16 *buf, unsigned int buf_words)
312 for (i = 0; i < buf_words; i++)
313 buf[i] = le16_to_cpu(buf[i]);
314 #endif /* __BIG_ENDIAN */
317 static u64 ata_id_n_sectors(const u16 *id)
319 if (ata_id_has_lba(id)) {
320 if (ata_id_has_lba48(id))
321 return ata_id_u64(id, 100);
323 return ata_id_u32(id, 60);
325 if (ata_id_current_chs_valid(id))
326 return ata_id_u32(id, 57);
328 return id[1] * id[3] * id[6];
332 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs,
351 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs,
358 ata_id_string(id, s, ofs, len - 1);
360 p = s + strnlen(s, len - 1);
361 while (p > s && p[-1] == ' ')
366 static int ps3disk_identify(struct ps3_storage_device *dev)
368 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
369 struct lv1_ata_cmnd_block ata_cmnd;
370 u16 *id = dev->bounce_buf;
373 dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__);
375 memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block));
376 ata_cmnd.command = ATA_CMD_ID_ATA;
377 ata_cmnd.sector_count = 1;
378 ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2;
379 ata_cmnd.buffer = dev->bounce_lpar;
380 ata_cmnd.proto = PIO_DATA_IN_PROTO;
381 ata_cmnd.in_out = DIR_READ;
383 res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND,
384 ps3_mm_phys_to_lpar(__pa(&ata_cmnd)),
385 sizeof(ata_cmnd), ata_cmnd.buffer,
388 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%llx\n",
389 __func__, __LINE__, res);
393 swap_buf_le16(id, ATA_ID_WORDS);
395 /* All we're interested in are raw capacity and model name */
396 priv->raw_capacity = ata_id_n_sectors(id);
397 ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model));
401 static void ps3disk_prepare_flush(struct request_queue *q, struct request *req)
403 struct ps3_storage_device *dev = q->queuedata;
405 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
407 req->cmd_type = REQ_TYPE_LINUX_BLOCK;
408 req->cmd[0] = REQ_LB_OP_FLUSH;
411 static unsigned long ps3disk_mask;
413 static DEFINE_MUTEX(ps3disk_mask_mutex);
415 static int __devinit ps3disk_probe(struct ps3_system_bus_device *_dev)
417 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
418 struct ps3disk_private *priv;
421 struct request_queue *queue;
422 struct gendisk *gendisk;
424 if (dev->blk_size < 512) {
425 dev_err(&dev->sbd.core,
426 "%s:%u: cannot handle block size %llu\n", __func__,
427 __LINE__, dev->blk_size);
431 BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
432 mutex_lock(&ps3disk_mask_mutex);
433 devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
434 if (devidx >= PS3DISK_MAX_DISKS) {
435 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
437 mutex_unlock(&ps3disk_mask_mutex);
440 __set_bit(devidx, &ps3disk_mask);
441 mutex_unlock(&ps3disk_mask_mutex);
443 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
449 ps3_system_bus_set_drvdata(_dev, priv);
450 spin_lock_init(&priv->lock);
452 dev->bounce_size = BOUNCE_SIZE;
453 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
454 if (!dev->bounce_buf) {
459 error = ps3stor_setup(dev, ps3disk_interrupt);
461 goto fail_free_bounce;
463 ps3disk_identify(dev);
465 queue = blk_init_queue(ps3disk_request, &priv->lock);
467 dev_err(&dev->sbd.core, "%s:%u: blk_init_queue failed\n",
474 queue->queuedata = dev;
476 blk_queue_bounce_limit(queue, BLK_BOUNCE_HIGH);
478 blk_queue_max_hw_sectors(queue, dev->bounce_size >> 9);
479 blk_queue_segment_boundary(queue, -1UL);
480 blk_queue_dma_alignment(queue, dev->blk_size-1);
481 blk_queue_logical_block_size(queue, dev->blk_size);
483 blk_queue_ordered(queue, QUEUE_ORDERED_DRAIN_FLUSH,
484 ps3disk_prepare_flush);
486 blk_queue_max_segments(queue, -1);
487 blk_queue_max_segment_size(queue, dev->bounce_size);
489 gendisk = alloc_disk(PS3DISK_MINORS);
491 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
494 goto fail_cleanup_queue;
497 priv->gendisk = gendisk;
498 gendisk->major = ps3disk_major;
499 gendisk->first_minor = devidx * PS3DISK_MINORS;
500 gendisk->fops = &ps3disk_fops;
501 gendisk->queue = queue;
502 gendisk->private_data = dev;
503 gendisk->driverfs_dev = &dev->sbd.core;
504 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
506 priv->blocking_factor = dev->blk_size >> 9;
507 set_capacity(gendisk,
508 dev->regions[dev->region_idx].size*priv->blocking_factor);
510 dev_info(&dev->sbd.core,
511 "%s is a %s (%llu MiB total, %lu MiB for OtherOS)\n",
512 gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
513 get_capacity(gendisk) >> 11);
519 blk_cleanup_queue(queue);
521 ps3stor_teardown(dev);
523 kfree(dev->bounce_buf);
526 ps3_system_bus_set_drvdata(_dev, NULL);
528 mutex_lock(&ps3disk_mask_mutex);
529 __clear_bit(devidx, &ps3disk_mask);
530 mutex_unlock(&ps3disk_mask_mutex);
534 static int ps3disk_remove(struct ps3_system_bus_device *_dev)
536 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
537 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
539 mutex_lock(&ps3disk_mask_mutex);
540 __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
542 mutex_unlock(&ps3disk_mask_mutex);
543 del_gendisk(priv->gendisk);
544 blk_cleanup_queue(priv->queue);
545 put_disk(priv->gendisk);
546 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
547 ps3disk_sync_cache(dev);
548 ps3stor_teardown(dev);
549 kfree(dev->bounce_buf);
551 ps3_system_bus_set_drvdata(_dev, NULL);
555 static struct ps3_system_bus_driver ps3disk = {
556 .match_id = PS3_MATCH_ID_STOR_DISK,
557 .core.name = DEVICE_NAME,
558 .core.owner = THIS_MODULE,
559 .probe = ps3disk_probe,
560 .remove = ps3disk_remove,
561 .shutdown = ps3disk_remove,
565 static int __init ps3disk_init(void)
569 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
572 error = register_blkdev(0, DEVICE_NAME);
574 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
578 ps3disk_major = error;
580 pr_info("%s:%u: registered block device major %d\n", __func__,
581 __LINE__, ps3disk_major);
583 error = ps3_system_bus_driver_register(&ps3disk);
585 unregister_blkdev(ps3disk_major, DEVICE_NAME);
590 static void __exit ps3disk_exit(void)
592 ps3_system_bus_driver_unregister(&ps3disk);
593 unregister_blkdev(ps3disk_major, DEVICE_NAME);
596 module_init(ps3disk_init);
597 module_exit(ps3disk_exit);
599 MODULE_LICENSE("GPL");
600 MODULE_DESCRIPTION("PS3 Disk Storage Driver");
601 MODULE_AUTHOR("Sony Corporation");
602 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);