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>
24 #include <asm/lv1call.h>
25 #include <asm/ps3stor.h>
26 #include <asm/firmware.h>
29 #define DEVICE_NAME "ps3disk"
31 #define BOUNCE_SIZE (64*1024)
33 #define PS3DISK_MAX_DISKS 16
34 #define PS3DISK_MINORS 16
37 #define PS3DISK_NAME "ps3d%c"
40 struct ps3disk_private {
41 spinlock_t lock; /* Request queue spinlock */
42 struct request_queue *queue;
43 struct gendisk *gendisk;
44 unsigned int blocking_factor;
47 unsigned char model[ATA_ID_PROD_LEN+1];
51 #define LV1_STORAGE_SEND_ATA_COMMAND (2)
52 #define LV1_STORAGE_ATA_HDDOUT (0x23)
54 struct lv1_ata_cmnd_block {
72 PIO_DATA_IN_PROTO = 1,
73 PIO_DATA_OUT_PROTO = 2,
78 DIR_WRITE = 0, /* memory -> device */
79 DIR_READ = 1 /* device -> memory */
82 static int ps3disk_major;
85 static struct block_device_operations ps3disk_fops = {
90 static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
91 struct request *req, int gather)
93 unsigned int offset = 0;
94 struct req_iterator iter;
100 rq_for_each_segment(bvec, req, iter) {
102 dev_dbg(&dev->sbd.core,
103 "%s:%u: bio %u: %u segs %u sectors from %lu\n",
104 __func__, __LINE__, i, bio_segments(iter.bio),
105 bio_sectors(iter.bio),
106 (unsigned long)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 = dev->sbd.core.driver_data;
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 %lu sectors %lu hard sectors\n",
139 __func__, __LINE__, op, n, req->nr_sectors,
140 req->hard_nr_sectors);
143 start_sector = req->sector * priv->blocking_factor;
144 sectors = req->nr_sectors * priv->blocking_factor;
145 dev_dbg(&dev->sbd.core, "%s:%u: %s %lu sectors starting at %lu\n",
146 __func__, __LINE__, op, sectors, start_sector);
149 ps3disk_scatter_gather(dev, req, 1);
151 res = lv1_storage_write(dev->sbd.dev_id, region_id,
152 start_sector, sectors, 0,
153 dev->bounce_lpar, &dev->tag);
155 res = lv1_storage_read(dev->sbd.dev_id, region_id,
156 start_sector, sectors, 0,
157 dev->bounce_lpar, &dev->tag);
160 dev_err(&dev->sbd.core, "%s:%u: %s failed %d\n", __func__,
170 static int ps3disk_submit_flush_request(struct ps3_storage_device *dev,
173 struct ps3disk_private *priv = dev->sbd.core.driver_data;
176 dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
178 res = lv1_storage_send_device_command(dev->sbd.dev_id,
179 LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
182 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%lx\n",
183 __func__, __LINE__, res);
192 static void ps3disk_do_request(struct ps3_storage_device *dev,
193 struct request_queue *q)
197 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
199 while ((req = elv_next_request(q))) {
200 if (blk_fs_request(req)) {
201 if (ps3disk_submit_request_sg(dev, req))
203 } else if (req->cmd_type == REQ_TYPE_FLUSH) {
204 if (ps3disk_submit_flush_request(dev, req))
207 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
214 static void ps3disk_request(struct request_queue *q)
216 struct ps3_storage_device *dev = q->queuedata;
217 struct ps3disk_private *priv = dev->sbd.core.driver_data;
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, uptodate;
234 unsigned long num_sectors;
237 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
240 dev_err(&dev->sbd.core,
241 "%s:%u: tag mismatch, got %lx, expected %lx\n",
242 __func__, __LINE__, tag, dev->tag);
245 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%lx\n",
246 __func__, __LINE__, res, status);
250 priv = dev->sbd.core.driver_data;
253 dev_dbg(&dev->sbd.core,
254 "%s:%u non-block layer request completed\n", __func__,
256 dev->lv1_status = status;
257 complete(&dev->done);
261 if (req->cmd_type == REQ_TYPE_FLUSH) {
263 num_sectors = req->hard_cur_sectors;
266 read = !rq_data_dir(req);
267 num_sectors = req->nr_sectors;
268 op = read ? "read" : "write";
271 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%lx\n", __func__,
272 __LINE__, op, status);
275 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
279 ps3disk_scatter_gather(dev, req, 0);
282 spin_lock(&priv->lock);
283 if (!end_that_request_first(req, uptodate, num_sectors)) {
284 add_disk_randomness(req->rq_disk);
285 blkdev_dequeue_request(req);
286 end_that_request_last(req, uptodate);
289 ps3disk_do_request(dev, priv->queue);
290 spin_unlock(&priv->lock);
295 static int ps3disk_sync_cache(struct ps3_storage_device *dev)
299 dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__);
301 res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0);
303 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%lx\n",
304 __func__, __LINE__, res);
311 /* ATA helpers copied from drivers/ata/libata-core.c */
313 static void swap_buf_le16(u16 *buf, unsigned int buf_words)
318 for (i = 0; i < buf_words; i++)
319 buf[i] = le16_to_cpu(buf[i]);
320 #endif /* __BIG_ENDIAN */
323 static u64 ata_id_n_sectors(const u16 *id)
325 if (ata_id_has_lba(id)) {
326 if (ata_id_has_lba48(id))
327 return ata_id_u64(id, 100);
329 return ata_id_u32(id, 60);
331 if (ata_id_current_chs_valid(id))
332 return ata_id_u32(id, 57);
334 return id[1] * id[3] * id[6];
338 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs,
357 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs,
364 ata_id_string(id, s, ofs, len - 1);
366 p = s + strnlen(s, len - 1);
367 while (p > s && p[-1] == ' ')
372 static int ps3disk_identify(struct ps3_storage_device *dev)
374 struct ps3disk_private *priv = dev->sbd.core.driver_data;
375 struct lv1_ata_cmnd_block ata_cmnd;
376 u16 *id = dev->bounce_buf;
379 dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__);
381 memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block));
382 ata_cmnd.command = ATA_CMD_ID_ATA;
383 ata_cmnd.sector_count = 1;
384 ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2;
385 ata_cmnd.buffer = dev->bounce_lpar;
386 ata_cmnd.proto = PIO_DATA_IN_PROTO;
387 ata_cmnd.in_out = DIR_READ;
389 res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND,
390 ps3_mm_phys_to_lpar(__pa(&ata_cmnd)),
391 sizeof(ata_cmnd), ata_cmnd.buffer,
394 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%lx\n",
395 __func__, __LINE__, res);
399 swap_buf_le16(id, ATA_ID_WORDS);
401 /* All we're interested in are raw capacity and model name */
402 priv->raw_capacity = ata_id_n_sectors(id);
403 ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model));
407 static void ps3disk_prepare_flush(struct request_queue *q, struct request *req)
409 struct ps3_storage_device *dev = q->queuedata;
411 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
413 memset(req->cmd, 0, sizeof(req->cmd));
414 req->cmd_type = REQ_TYPE_FLUSH;
417 static unsigned long ps3disk_mask;
419 static DEFINE_MUTEX(ps3disk_mask_mutex);
421 static int __devinit ps3disk_probe(struct ps3_system_bus_device *_dev)
423 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
424 struct ps3disk_private *priv;
427 struct request_queue *queue;
428 struct gendisk *gendisk;
430 if (dev->blk_size < 512) {
431 dev_err(&dev->sbd.core,
432 "%s:%u: cannot handle block size %lu\n", __func__,
433 __LINE__, dev->blk_size);
437 BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
438 mutex_lock(&ps3disk_mask_mutex);
439 devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
440 if (devidx >= PS3DISK_MAX_DISKS) {
441 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
443 mutex_unlock(&ps3disk_mask_mutex);
446 __set_bit(devidx, &ps3disk_mask);
447 mutex_unlock(&ps3disk_mask_mutex);
449 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
455 dev->sbd.core.driver_data = priv;
456 spin_lock_init(&priv->lock);
458 dev->bounce_size = BOUNCE_SIZE;
459 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
460 if (!dev->bounce_buf) {
465 error = ps3stor_setup(dev, ps3disk_interrupt);
467 goto fail_free_bounce;
469 ps3disk_identify(dev);
471 queue = blk_init_queue(ps3disk_request, &priv->lock);
473 dev_err(&dev->sbd.core, "%s:%u: blk_init_queue failed\n",
480 queue->queuedata = dev;
482 blk_queue_bounce_limit(queue, BLK_BOUNCE_HIGH);
484 blk_queue_max_sectors(queue, dev->bounce_size >> 9);
485 blk_queue_segment_boundary(queue, -1UL);
486 blk_queue_dma_alignment(queue, dev->blk_size-1);
487 blk_queue_hardsect_size(queue, dev->blk_size);
489 blk_queue_ordered(queue, QUEUE_ORDERED_DRAIN_FLUSH,
490 ps3disk_prepare_flush);
492 blk_queue_max_phys_segments(queue, -1);
493 blk_queue_max_hw_segments(queue, -1);
494 blk_queue_max_segment_size(queue, dev->bounce_size);
496 gendisk = alloc_disk(PS3DISK_MINORS);
498 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
501 goto fail_cleanup_queue;
504 priv->gendisk = gendisk;
505 gendisk->major = ps3disk_major;
506 gendisk->first_minor = devidx * PS3DISK_MINORS;
507 gendisk->fops = &ps3disk_fops;
508 gendisk->queue = queue;
509 gendisk->private_data = dev;
510 gendisk->driverfs_dev = &dev->sbd.core;
511 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
513 priv->blocking_factor = dev->blk_size >> 9;
514 set_capacity(gendisk,
515 dev->regions[dev->region_idx].size*priv->blocking_factor);
517 dev_info(&dev->sbd.core,
518 "%s is a %s (%lu MiB total, %lu MiB for OtherOS)\n",
519 gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
520 get_capacity(gendisk) >> 11);
526 blk_cleanup_queue(queue);
528 ps3stor_teardown(dev);
530 kfree(dev->bounce_buf);
533 dev->sbd.core.driver_data = NULL;
535 mutex_lock(&ps3disk_mask_mutex);
536 __clear_bit(devidx, &ps3disk_mask);
537 mutex_unlock(&ps3disk_mask_mutex);
541 static int ps3disk_remove(struct ps3_system_bus_device *_dev)
543 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
544 struct ps3disk_private *priv = dev->sbd.core.driver_data;
546 mutex_lock(&ps3disk_mask_mutex);
547 __clear_bit(priv->gendisk->first_minor / PS3DISK_MINORS,
549 mutex_unlock(&ps3disk_mask_mutex);
550 del_gendisk(priv->gendisk);
551 blk_cleanup_queue(priv->queue);
552 put_disk(priv->gendisk);
553 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
554 ps3disk_sync_cache(dev);
555 ps3stor_teardown(dev);
556 kfree(dev->bounce_buf);
558 dev->sbd.core.driver_data = NULL;
562 static struct ps3_system_bus_driver ps3disk = {
563 .match_id = PS3_MATCH_ID_STOR_DISK,
564 .core.name = DEVICE_NAME,
565 .core.owner = THIS_MODULE,
566 .probe = ps3disk_probe,
567 .remove = ps3disk_remove,
568 .shutdown = ps3disk_remove,
572 static int __init ps3disk_init(void)
576 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
579 error = register_blkdev(0, DEVICE_NAME);
581 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
585 ps3disk_major = error;
587 pr_info("%s:%u: registered block device major %d\n", __func__,
588 __LINE__, ps3disk_major);
590 error = ps3_system_bus_driver_register(&ps3disk);
592 unregister_blkdev(ps3disk_major, DEVICE_NAME);
597 static void __exit ps3disk_exit(void)
599 ps3_system_bus_driver_unregister(&ps3disk);
600 unregister_blkdev(ps3disk_major, DEVICE_NAME);
603 module_init(ps3disk_init);
604 module_exit(ps3disk_exit);
606 MODULE_LICENSE("GPL");
607 MODULE_DESCRIPTION("PS3 Disk Storage Driver");
608 MODULE_AUTHOR("Sony Corporation");
609 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);