1 // SPDX-License-Identifier: GPL-2.0-only
3 * PS3 Disk Storage Driver
5 * Copyright (C) 2007 Sony Computer Entertainment Inc.
6 * Copyright 2007 Sony Corp.
10 #include <linux/blk-mq.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
14 #include <asm/lv1call.h>
15 #include <asm/ps3stor.h>
16 #include <asm/firmware.h>
19 #define DEVICE_NAME "ps3disk"
21 #define BOUNCE_SIZE (64*1024)
23 #define PS3DISK_MAX_DISKS 16
24 #define PS3DISK_MINORS 16
27 #define PS3DISK_NAME "ps3d%c"
30 struct ps3disk_private {
31 spinlock_t lock; /* Request queue spinlock */
32 struct request_queue *queue;
33 struct blk_mq_tag_set tag_set;
34 struct gendisk *gendisk;
35 unsigned int blocking_factor;
38 unsigned char model[ATA_ID_PROD_LEN+1];
42 #define LV1_STORAGE_SEND_ATA_COMMAND (2)
43 #define LV1_STORAGE_ATA_HDDOUT (0x23)
45 struct lv1_ata_cmnd_block {
63 PIO_DATA_IN_PROTO = 1,
64 PIO_DATA_OUT_PROTO = 2,
69 DIR_WRITE = 0, /* memory -> device */
70 DIR_READ = 1 /* device -> memory */
73 static int ps3disk_major;
76 static const struct block_device_operations ps3disk_fops = {
81 static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
82 struct request *req, int gather)
84 unsigned int offset = 0;
85 struct req_iterator iter;
91 rq_for_each_segment(bvec, req, iter) {
93 dev_dbg(&dev->sbd.core, "%s:%u: bio %u: %u sectors from %llu\n",
94 __func__, __LINE__, i, bio_sectors(iter.bio),
95 iter.bio->bi_iter.bi_sector);
98 buf = bvec_kmap_irq(&bvec, &flags);
100 memcpy(dev->bounce_buf+offset, buf, size);
102 memcpy(buf, dev->bounce_buf+offset, size);
104 flush_kernel_dcache_page(bvec.bv_page);
105 bvec_kunmap_irq(buf, &flags);
110 static blk_status_t ps3disk_submit_request_sg(struct ps3_storage_device *dev,
113 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
114 int write = rq_data_dir(req), res;
115 const char *op = write ? "write" : "read";
116 u64 start_sector, sectors;
117 unsigned int region_id = dev->regions[dev->region_idx].id;
122 struct req_iterator iter;
124 rq_for_each_segment(bv, req, iter)
126 dev_dbg(&dev->sbd.core,
127 "%s:%u: %s req has %u bvecs for %u sectors\n",
128 __func__, __LINE__, op, n, blk_rq_sectors(req));
131 start_sector = blk_rq_pos(req) * priv->blocking_factor;
132 sectors = blk_rq_sectors(req) * priv->blocking_factor;
133 dev_dbg(&dev->sbd.core, "%s:%u: %s %llu sectors starting at %llu\n",
134 __func__, __LINE__, op, sectors, start_sector);
137 ps3disk_scatter_gather(dev, req, 1);
139 res = lv1_storage_write(dev->sbd.dev_id, region_id,
140 start_sector, sectors, 0,
141 dev->bounce_lpar, &dev->tag);
143 res = lv1_storage_read(dev->sbd.dev_id, region_id,
144 start_sector, sectors, 0,
145 dev->bounce_lpar, &dev->tag);
148 dev_err(&dev->sbd.core, "%s:%u: %s failed %d\n", __func__,
150 return BLK_STS_IOERR;
157 static blk_status_t ps3disk_submit_flush_request(struct ps3_storage_device *dev,
160 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
163 dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
165 res = lv1_storage_send_device_command(dev->sbd.dev_id,
166 LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
169 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
170 __func__, __LINE__, res);
171 return BLK_STS_IOERR;
178 static blk_status_t ps3disk_do_request(struct ps3_storage_device *dev,
181 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
183 switch (req_op(req)) {
185 return ps3disk_submit_flush_request(dev, req);
188 return ps3disk_submit_request_sg(dev, req);
190 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
191 return BLK_STS_IOERR;
195 static blk_status_t ps3disk_queue_rq(struct blk_mq_hw_ctx *hctx,
196 const struct blk_mq_queue_data *bd)
198 struct request_queue *q = hctx->queue;
199 struct ps3_storage_device *dev = q->queuedata;
200 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
203 blk_mq_start_request(bd->rq);
205 spin_lock_irq(&priv->lock);
206 ret = ps3disk_do_request(dev, bd->rq);
207 spin_unlock_irq(&priv->lock);
212 static irqreturn_t ps3disk_interrupt(int irq, void *data)
214 struct ps3_storage_device *dev = data;
215 struct ps3disk_private *priv;
222 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
225 dev_err(&dev->sbd.core,
226 "%s:%u: tag mismatch, got %llx, expected %llx\n",
227 __func__, __LINE__, tag, dev->tag);
230 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
231 __func__, __LINE__, res, status);
235 priv = ps3_system_bus_get_drvdata(&dev->sbd);
238 dev_dbg(&dev->sbd.core,
239 "%s:%u non-block layer request completed\n", __func__,
241 dev->lv1_status = status;
242 complete(&dev->done);
246 if (req_op(req) == REQ_OP_FLUSH) {
250 read = !rq_data_dir(req);
251 op = read ? "read" : "write";
254 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
255 __LINE__, op, status);
256 error = BLK_STS_IOERR;
258 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
262 ps3disk_scatter_gather(dev, req, 0);
265 spin_lock(&priv->lock);
267 blk_mq_end_request(req, error);
268 spin_unlock(&priv->lock);
270 blk_mq_run_hw_queues(priv->queue, true);
274 static int ps3disk_sync_cache(struct ps3_storage_device *dev)
278 dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__);
280 res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0);
282 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
283 __func__, __LINE__, res);
290 /* ATA helpers copied from drivers/ata/libata-core.c */
292 static void swap_buf_le16(u16 *buf, unsigned int buf_words)
297 for (i = 0; i < buf_words; i++)
298 buf[i] = le16_to_cpu(buf[i]);
299 #endif /* __BIG_ENDIAN */
302 static u64 ata_id_n_sectors(const u16 *id)
304 if (ata_id_has_lba(id)) {
305 if (ata_id_has_lba48(id))
306 return ata_id_u64(id, 100);
308 return ata_id_u32(id, 60);
310 if (ata_id_current_chs_valid(id))
311 return ata_id_u32(id, 57);
313 return id[1] * id[3] * id[6];
317 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs,
336 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs,
343 ata_id_string(id, s, ofs, len - 1);
345 p = s + strnlen(s, len - 1);
346 while (p > s && p[-1] == ' ')
351 static int ps3disk_identify(struct ps3_storage_device *dev)
353 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
354 struct lv1_ata_cmnd_block ata_cmnd;
355 u16 *id = dev->bounce_buf;
358 dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__);
360 memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block));
361 ata_cmnd.command = ATA_CMD_ID_ATA;
362 ata_cmnd.sector_count = 1;
363 ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2;
364 ata_cmnd.buffer = dev->bounce_lpar;
365 ata_cmnd.proto = PIO_DATA_IN_PROTO;
366 ata_cmnd.in_out = DIR_READ;
368 res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND,
369 ps3_mm_phys_to_lpar(__pa(&ata_cmnd)),
370 sizeof(ata_cmnd), ata_cmnd.buffer,
373 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%llx\n",
374 __func__, __LINE__, res);
378 swap_buf_le16(id, ATA_ID_WORDS);
380 /* All we're interested in are raw capacity and model name */
381 priv->raw_capacity = ata_id_n_sectors(id);
382 ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model));
386 static unsigned long ps3disk_mask;
388 static DEFINE_MUTEX(ps3disk_mask_mutex);
390 static const struct blk_mq_ops ps3disk_mq_ops = {
391 .queue_rq = ps3disk_queue_rq,
394 static int ps3disk_probe(struct ps3_system_bus_device *_dev)
396 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
397 struct ps3disk_private *priv;
400 struct request_queue *queue;
401 struct gendisk *gendisk;
403 if (dev->blk_size < 512) {
404 dev_err(&dev->sbd.core,
405 "%s:%u: cannot handle block size %llu\n", __func__,
406 __LINE__, dev->blk_size);
410 BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
411 mutex_lock(&ps3disk_mask_mutex);
412 devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
413 if (devidx >= PS3DISK_MAX_DISKS) {
414 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
416 mutex_unlock(&ps3disk_mask_mutex);
419 __set_bit(devidx, &ps3disk_mask);
420 mutex_unlock(&ps3disk_mask_mutex);
422 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
428 ps3_system_bus_set_drvdata(_dev, priv);
429 spin_lock_init(&priv->lock);
431 dev->bounce_size = BOUNCE_SIZE;
432 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
433 if (!dev->bounce_buf) {
438 error = ps3stor_setup(dev, ps3disk_interrupt);
440 goto fail_free_bounce;
442 ps3disk_identify(dev);
444 queue = blk_mq_init_sq_queue(&priv->tag_set, &ps3disk_mq_ops, 1,
445 BLK_MQ_F_SHOULD_MERGE);
447 dev_err(&dev->sbd.core, "%s:%u: blk_mq_init_queue failed\n",
449 error = PTR_ERR(queue);
454 queue->queuedata = dev;
456 blk_queue_max_hw_sectors(queue, dev->bounce_size >> 9);
457 blk_queue_dma_alignment(queue, dev->blk_size-1);
458 blk_queue_logical_block_size(queue, dev->blk_size);
460 blk_queue_write_cache(queue, true, false);
462 blk_queue_max_segments(queue, -1);
463 blk_queue_max_segment_size(queue, dev->bounce_size);
465 gendisk = alloc_disk(PS3DISK_MINORS);
467 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
470 goto fail_cleanup_queue;
473 priv->gendisk = gendisk;
474 gendisk->major = ps3disk_major;
475 gendisk->first_minor = devidx * PS3DISK_MINORS;
476 gendisk->fops = &ps3disk_fops;
477 gendisk->queue = queue;
478 gendisk->private_data = dev;
479 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
481 priv->blocking_factor = dev->blk_size >> 9;
482 set_capacity(gendisk,
483 dev->regions[dev->region_idx].size*priv->blocking_factor);
485 dev_info(&dev->sbd.core,
486 "%s is a %s (%llu MiB total, %llu MiB for OtherOS)\n",
487 gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
488 get_capacity(gendisk) >> 11);
490 device_add_disk(&dev->sbd.core, gendisk, NULL);
494 blk_cleanup_queue(queue);
495 blk_mq_free_tag_set(&priv->tag_set);
497 ps3stor_teardown(dev);
499 kfree(dev->bounce_buf);
502 ps3_system_bus_set_drvdata(_dev, NULL);
504 mutex_lock(&ps3disk_mask_mutex);
505 __clear_bit(devidx, &ps3disk_mask);
506 mutex_unlock(&ps3disk_mask_mutex);
510 static int ps3disk_remove(struct ps3_system_bus_device *_dev)
512 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
513 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
515 mutex_lock(&ps3disk_mask_mutex);
516 __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
518 mutex_unlock(&ps3disk_mask_mutex);
519 del_gendisk(priv->gendisk);
520 blk_cleanup_queue(priv->queue);
521 blk_mq_free_tag_set(&priv->tag_set);
522 put_disk(priv->gendisk);
523 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
524 ps3disk_sync_cache(dev);
525 ps3stor_teardown(dev);
526 kfree(dev->bounce_buf);
528 ps3_system_bus_set_drvdata(_dev, NULL);
532 static struct ps3_system_bus_driver ps3disk = {
533 .match_id = PS3_MATCH_ID_STOR_DISK,
534 .core.name = DEVICE_NAME,
535 .core.owner = THIS_MODULE,
536 .probe = ps3disk_probe,
537 .remove = ps3disk_remove,
538 .shutdown = ps3disk_remove,
542 static int __init ps3disk_init(void)
546 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
549 error = register_blkdev(0, DEVICE_NAME);
551 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
555 ps3disk_major = error;
557 pr_info("%s:%u: registered block device major %d\n", __func__,
558 __LINE__, ps3disk_major);
560 error = ps3_system_bus_driver_register(&ps3disk);
562 unregister_blkdev(ps3disk_major, DEVICE_NAME);
567 static void __exit ps3disk_exit(void)
569 ps3_system_bus_driver_unregister(&ps3disk);
570 unregister_blkdev(ps3disk_major, DEVICE_NAME);
573 module_init(ps3disk_init);
574 module_exit(ps3disk_exit);
576 MODULE_LICENSE("GPL");
577 MODULE_DESCRIPTION("PS3 Disk Storage Driver");
578 MODULE_AUTHOR("Sony Corporation");
579 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);