drivers/block/ps3disk.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * PS3 Disk Storage Driver
   4  *
   5  * Copyright (C) 2007 Sony Computer Entertainment Inc.
   6  * Copyright 2007 Sony Corp.
   7  */
   8
   9 #include <linux/ata.h>
  10 #include <linux/blk-mq.h>
  11 #include <linux/slab.h>
  12 #include <linux/module.h>
  13
  14 #include <asm/lv1call.h>
  15 #include <asm/ps3stor.h>
  16 #include <asm/firmware.h>
  17
  18
  19 #define DEVICE_NAME             "ps3disk"
  20
  21 #define BOUNCE_SIZE             (64*1024)
  22
  23 #define PS3DISK_MAX_DISKS       16
  24 #define PS3DISK_MINORS          16
  25
  26
  27 #define PS3DISK_NAME            "ps3d%c"
  28
  29
  30 struct ps3disk_private {
  31         spinlock_t lock;                /* Request queue spinlock */
  32         struct blk_mq_tag_set tag_set;
  33         struct gendisk *gendisk;
  34         unsigned int blocking_factor;
  35         struct request *req;
  36         u64 raw_capacity;
  37         unsigned char model[ATA_ID_PROD_LEN+1];
  38 };
  39
  40
  41 #define LV1_STORAGE_SEND_ATA_COMMAND    (2)
  42 #define LV1_STORAGE_ATA_HDDOUT          (0x23)
  43
  44 struct lv1_ata_cmnd_block {
  45         u16     features;
  46         u16     sector_count;
  47         u16     LBA_low;
  48         u16     LBA_mid;
  49         u16     LBA_high;
  50         u8      device;
  51         u8      command;
  52         u32     is_ext;
  53         u32     proto;
  54         u32     in_out;
  55         u32     size;
  56         u64     buffer;
  57         u32     arglen;
  58 };
  59
  60 enum lv1_ata_proto {
  61         NON_DATA_PROTO     = 0,
  62         PIO_DATA_IN_PROTO  = 1,
  63         PIO_DATA_OUT_PROTO = 2,
  64         DMA_PROTO = 3
  65 };
  66
  67 enum lv1_ata_in_out {
  68         DIR_WRITE = 0,                  /* memory -> device */
  69         DIR_READ = 1                    /* device -> memory */
  70 };
  71
  72 static int ps3disk_major;
  73
  74
  75 static const struct block_device_operations ps3disk_fops = {
  76         .owner          = THIS_MODULE,
  77 };
  78
  79
  80 static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
  81                                    struct request *req, int gather)
  82 {
  83         unsigned int offset = 0;
  84         struct req_iterator iter;
  85         struct bio_vec bvec;
  86
  87         rq_for_each_segment(bvec, req, iter) {
  88                 if (gather)
  89                         memcpy_from_bvec(dev->bounce_buf + offset, &bvec);
  90                 else
  91                         memcpy_to_bvec(&bvec, dev->bounce_buf + offset);
  92         }
  93 }
  94
  95 static blk_status_t ps3disk_submit_request_sg(struct ps3_storage_device *dev,
  96                                               struct request *req)
  97 {
  98         struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
  99         int write = rq_data_dir(req), res;
 100         const char *op = write ? "write" : "read";
 101         u64 start_sector, sectors;
 102         unsigned int region_id = dev->regions[dev->region_idx].id;
 103
 104 #ifdef DEBUG
 105         unsigned int n = 0;
 106         struct bio_vec bv;
 107         struct req_iterator iter;
 108
 109         rq_for_each_segment(bv, req, iter)
 110                 n++;
 111         dev_dbg(&dev->sbd.core,
 112                 "%s:%u: %s req has %u bvecs for %u sectors\n",
 113                 __func__, __LINE__, op, n, blk_rq_sectors(req));
 114 #endif
 115
 116         start_sector = blk_rq_pos(req) * priv->blocking_factor;
 117         sectors = blk_rq_sectors(req) * priv->blocking_factor;
 118         dev_dbg(&dev->sbd.core, "%s:%u: %s %llu sectors starting at %llu\n",
 119                 __func__, __LINE__, op, sectors, start_sector);
 120
 121         if (write) {
 122                 ps3disk_scatter_gather(dev, req, 1);
 123
 124                 res = lv1_storage_write(dev->sbd.dev_id, region_id,
 125                                         start_sector, sectors, 0,
 126                                         dev->bounce_lpar, &dev->tag);
 127         } else {
 128                 res = lv1_storage_read(dev->sbd.dev_id, region_id,
 129                                        start_sector, sectors, 0,
 130                                        dev->bounce_lpar, &dev->tag);
 131         }
 132         if (res) {
 133                 dev_err(&dev->sbd.core, "%s:%u: %s failed %d\n", __func__,
 134                         __LINE__, op, res);
 135                 return BLK_STS_IOERR;
 136         }
 137
 138         priv->req = req;
 139         return BLK_STS_OK;
 140 }
 141
 142 static blk_status_t ps3disk_submit_flush_request(struct ps3_storage_device *dev,
 143                                                  struct request *req)
 144 {
 145         struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
 146         u64 res;
 147
 148         dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
 149
 150         res = lv1_storage_send_device_command(dev->sbd.dev_id,
 151                                               LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
 152                                               0, &dev->tag);
 153         if (res) {
 154                 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
 155                         __func__, __LINE__, res);
 156                 return BLK_STS_IOERR;
 157         }
 158
 159         priv->req = req;
 160         return BLK_STS_OK;
 161 }
 162
 163 static blk_status_t ps3disk_do_request(struct ps3_storage_device *dev,
 164                                        struct request *req)
 165 {
 166         dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
 167
 168         switch (req_op(req)) {
 169         case REQ_OP_FLUSH:
 170                 return ps3disk_submit_flush_request(dev, req);
 171         case REQ_OP_READ:
 172         case REQ_OP_WRITE:
 173                 return ps3disk_submit_request_sg(dev, req);
 174         default:
 175                 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
 176                 return BLK_STS_IOERR;
 177         }
 178 }
 179
 180 static blk_status_t ps3disk_queue_rq(struct blk_mq_hw_ctx *hctx,
 181                                      const struct blk_mq_queue_data *bd)
 182 {
 183         struct request_queue *q = hctx->queue;
 184         struct ps3_storage_device *dev = q->queuedata;
 185         struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
 186         blk_status_t ret;
 187
 188         blk_mq_start_request(bd->rq);
 189
 190         spin_lock_irq(&priv->lock);
 191         ret = ps3disk_do_request(dev, bd->rq);
 192         spin_unlock_irq(&priv->lock);
 193
 194         return ret;
 195 }
 196
 197 static irqreturn_t ps3disk_interrupt(int irq, void *data)
 198 {
 199         struct ps3_storage_device *dev = data;
 200         struct ps3disk_private *priv;
 201         struct request *req;
 202         int res, read;
 203         blk_status_t error;
 204         u64 tag, status;
 205         const char *op;
 206
 207         res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
 208
 209         if (tag != dev->tag)
 210                 dev_err(&dev->sbd.core,
 211                         "%s:%u: tag mismatch, got %llx, expected %llx\n",
 212                         __func__, __LINE__, tag, dev->tag);
 213
 214         if (res) {
 215                 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
 216                         __func__, __LINE__, res, status);
 217                 return IRQ_HANDLED;
 218         }
 219
 220         priv = ps3_system_bus_get_drvdata(&dev->sbd);
 221         req = priv->req;
 222         if (!req) {
 223                 dev_dbg(&dev->sbd.core,
 224                         "%s:%u non-block layer request completed\n", __func__,
 225                         __LINE__);
 226                 dev->lv1_status = status;
 227                 complete(&dev->done);
 228                 return IRQ_HANDLED;
 229         }
 230
 231         if (req_op(req) == REQ_OP_FLUSH) {
 232                 read = 0;
 233                 op = "flush";
 234         } else {
 235                 read = !rq_data_dir(req);
 236                 op = read ? "read" : "write";
 237         }
 238         if (status) {
 239                 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
 240                         __LINE__, op, status);
 241                 error = BLK_STS_IOERR;
 242         } else {
 243                 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
 244                         __LINE__, op);
 245                 error = 0;
 246                 if (read)
 247                         ps3disk_scatter_gather(dev, req, 0);
 248         }
 249
 250         spin_lock(&priv->lock);
 251         priv->req = NULL;
 252         blk_mq_end_request(req, error);
 253         spin_unlock(&priv->lock);
 254
 255         blk_mq_run_hw_queues(priv->gendisk->queue, true);
 256         return IRQ_HANDLED;
 257 }
 258
 259 static int ps3disk_sync_cache(struct ps3_storage_device *dev)
 260 {
 261         u64 res;
 262
 263         dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__);
 264
 265         res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0);
 266         if (res) {
 267                 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
 268                         __func__, __LINE__, res);
 269                 return -EIO;
 270         }
 271         return 0;
 272 }
 273
 274
 275 /* ATA helpers copied from drivers/ata/libata-core.c */
 276
 277 static void swap_buf_le16(u16 *buf, unsigned int buf_words)
 278 {
 279 #ifdef __BIG_ENDIAN
 280         unsigned int i;
 281
 282         for (i = 0; i < buf_words; i++)
 283                 buf[i] = le16_to_cpu(buf[i]);
 284 #endif /* __BIG_ENDIAN */
 285 }
 286
 287 static u64 ata_id_n_sectors(const u16 *id)
 288 {
 289         if (ata_id_has_lba(id)) {
 290                 if (ata_id_has_lba48(id))
 291                         return ata_id_u64(id, 100);
 292                 else
 293                         return ata_id_u32(id, 60);
 294         } else {
 295                 if (ata_id_current_chs_valid(id))
 296                         return ata_id_u32(id, 57);
 297                 else
 298                         return id[1] * id[3] * id[6];
 299         }
 300 }
 301
 302 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs,
 303                           unsigned int len)
 304 {
 305         unsigned int c;
 306
 307         while (len > 0) {
 308                 c = id[ofs] >> 8;
 309                 *s = c;
 310                 s++;
 311
 312                 c = id[ofs] & 0xff;
 313                 *s = c;
 314                 s++;
 315
 316                 ofs++;
 317                 len -= 2;
 318         }
 319 }
 320
 321 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs,
 322                             unsigned int len)
 323 {
 324         unsigned char *p;
 325
 326         WARN_ON(!(len & 1));
 327
 328         ata_id_string(id, s, ofs, len - 1);
 329
 330         p = s + strnlen(s, len - 1);
 331         while (p > s && p[-1] == ' ')
 332                 p--;
 333         *p = '\0';
 334 }
 335
 336 static int ps3disk_identify(struct ps3_storage_device *dev)
 337 {
 338         struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
 339         struct lv1_ata_cmnd_block ata_cmnd;
 340         u16 *id = dev->bounce_buf;
 341         u64 res;
 342
 343         dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__);
 344
 345         memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block));
 346         ata_cmnd.command = ATA_CMD_ID_ATA;
 347         ata_cmnd.sector_count = 1;
 348         ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2;
 349         ata_cmnd.buffer = dev->bounce_lpar;
 350         ata_cmnd.proto = PIO_DATA_IN_PROTO;
 351         ata_cmnd.in_out = DIR_READ;
 352
 353         res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND,
 354                                    ps3_mm_phys_to_lpar(__pa(&ata_cmnd)),
 355                                    sizeof(ata_cmnd), ata_cmnd.buffer,
 356                                    ata_cmnd.arglen);
 357         if (res) {
 358                 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%llx\n",
 359                         __func__, __LINE__, res);
 360                 return -EIO;
 361         }
 362
 363         swap_buf_le16(id, ATA_ID_WORDS);
 364
 365         /* All we're interested in are raw capacity and model name */
 366         priv->raw_capacity = ata_id_n_sectors(id);
 367         ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model));
 368         return 0;
 369 }
 370
 371 static unsigned long ps3disk_mask;
 372
 373 static DEFINE_MUTEX(ps3disk_mask_mutex);
 374
 375 static const struct blk_mq_ops ps3disk_mq_ops = {
 376         .queue_rq       = ps3disk_queue_rq,
 377 };
 378
 379 static int ps3disk_probe(struct ps3_system_bus_device *_dev)
 380 {
 381         struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 382         struct ps3disk_private *priv;
 383         int error;
 384         unsigned int devidx;
 385         struct queue_limits lim = {
 386                 .logical_block_size     = dev->blk_size,
 387                 .max_hw_sectors         = dev->bounce_size >> 9,
 388                 .max_segments           = -1,
 389                 .max_segment_size       = dev->bounce_size,
 390                 .dma_alignment          = dev->blk_size - 1,
 391                 .features               = BLK_FEAT_WRITE_CACHE |
 392                                           BLK_FEAT_ROTATIONAL,
 393         };
 394         struct gendisk *gendisk;
 395
 396         if (dev->blk_size < 512) {
 397                 dev_err(&dev->sbd.core,
 398                         "%s:%u: cannot handle block size %llu\n", __func__,
 399                         __LINE__, dev->blk_size);
 400                 return -EINVAL;
 401         }
 402
 403         BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
 404         mutex_lock(&ps3disk_mask_mutex);
 405         devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
 406         if (devidx >= PS3DISK_MAX_DISKS) {
 407                 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
 408                         __LINE__);
 409                 mutex_unlock(&ps3disk_mask_mutex);
 410                 return -ENOSPC;
 411         }
 412         __set_bit(devidx, &ps3disk_mask);
 413         mutex_unlock(&ps3disk_mask_mutex);
 414
 415         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 416         if (!priv) {
 417                 error = -ENOMEM;
 418                 goto fail;
 419         }
 420
 421         ps3_system_bus_set_drvdata(_dev, priv);
 422         spin_lock_init(&priv->lock);
 423
 424         dev->bounce_size = BOUNCE_SIZE;
 425         dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
 426         if (!dev->bounce_buf) {
 427                 error = -ENOMEM;
 428                 goto fail_free_priv;
 429         }
 430
 431         error = ps3stor_setup(dev, ps3disk_interrupt);
 432         if (error)
 433                 goto fail_free_bounce;
 434
 435         ps3disk_identify(dev);
 436
 437         error = blk_mq_alloc_sq_tag_set(&priv->tag_set, &ps3disk_mq_ops, 1,
 438                                         BLK_MQ_F_SHOULD_MERGE);
 439         if (error)
 440                 goto fail_teardown;
 441
 442         gendisk = blk_mq_alloc_disk(&priv->tag_set, &lim, dev);
 443         if (IS_ERR(gendisk)) {
 444                 dev_err(&dev->sbd.core, "%s:%u: blk_mq_alloc_disk failed\n",
 445                         __func__, __LINE__);
 446                 error = PTR_ERR(gendisk);
 447                 goto fail_free_tag_set;
 448         }
 449
 450         priv->gendisk = gendisk;
 451         gendisk->major = ps3disk_major;
 452         gendisk->first_minor = devidx * PS3DISK_MINORS;
 453         gendisk->minors = PS3DISK_MINORS;
 454         gendisk->fops = &ps3disk_fops;
 455         gendisk->private_data = dev;
 456         snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
 457                  devidx+'a');
 458         priv->blocking_factor = dev->blk_size >> 9;
 459         set_capacity(gendisk,
 460                      dev->regions[dev->region_idx].size*priv->blocking_factor);
 461
 462         dev_info(&dev->sbd.core,
 463                  "%s is a %s (%llu MiB total, %llu MiB for OtherOS)\n",
 464                  gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
 465                  get_capacity(gendisk) >> 11);
 466
 467         error = device_add_disk(&dev->sbd.core, gendisk, NULL);
 468         if (error)
 469                 goto fail_cleanup_disk;
 470
 471         return 0;
 472 fail_cleanup_disk:
 473         put_disk(gendisk);
 474 fail_free_tag_set:
 475         blk_mq_free_tag_set(&priv->tag_set);
 476 fail_teardown:
 477         ps3stor_teardown(dev);
 478 fail_free_bounce:
 479         kfree(dev->bounce_buf);
 480 fail_free_priv:
 481         kfree(priv);
 482         ps3_system_bus_set_drvdata(_dev, NULL);
 483 fail:
 484         mutex_lock(&ps3disk_mask_mutex);
 485         __clear_bit(devidx, &ps3disk_mask);
 486         mutex_unlock(&ps3disk_mask_mutex);
 487         return error;
 488 }
 489
 490 static void ps3disk_remove(struct ps3_system_bus_device *_dev)
 491 {
 492         struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 493         struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
 494
 495         mutex_lock(&ps3disk_mask_mutex);
 496         __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
 497                     &ps3disk_mask);
 498         mutex_unlock(&ps3disk_mask_mutex);
 499         del_gendisk(priv->gendisk);
 500         put_disk(priv->gendisk);
 501         blk_mq_free_tag_set(&priv->tag_set);
 502         dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
 503         ps3disk_sync_cache(dev);
 504         ps3stor_teardown(dev);
 505         kfree(dev->bounce_buf);
 506         kfree(priv);
 507         ps3_system_bus_set_drvdata(_dev, NULL);
 508 }
 509
 510 static struct ps3_system_bus_driver ps3disk = {
 511         .match_id       = PS3_MATCH_ID_STOR_DISK,
 512         .core.name      = DEVICE_NAME,
 513         .core.owner     = THIS_MODULE,
 514         .probe          = ps3disk_probe,
 515         .remove         = ps3disk_remove,
 516         .shutdown       = ps3disk_remove,
 517 };
 518
 519
 520 static int __init ps3disk_init(void)
 521 {
 522         int error;
 523
 524         if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
 525                 return -ENODEV;
 526
 527         error = register_blkdev(0, DEVICE_NAME);
 528         if (error <= 0) {
 529                 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
 530                        __LINE__, error);
 531                 return error;
 532         }
 533         ps3disk_major = error;
 534
 535         pr_info("%s:%u: registered block device major %d\n", __func__,
 536                 __LINE__, ps3disk_major);
 537
 538         error = ps3_system_bus_driver_register(&ps3disk);
 539         if (error)
 540                 unregister_blkdev(ps3disk_major, DEVICE_NAME);
 541
 542         return error;
 543 }
 544
 545 static void __exit ps3disk_exit(void)
 546 {
 547         ps3_system_bus_driver_unregister(&ps3disk);
 548         unregister_blkdev(ps3disk_major, DEVICE_NAME);
 549 }
 550
 551 module_init(ps3disk_init);
 552 module_exit(ps3disk_exit);
 553
 554 MODULE_LICENSE("GPL");
 555 MODULE_DESCRIPTION("PS3 Disk Storage Driver");
 556 MODULE_AUTHOR("Sony Corporation");
 557 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);