drivers/block/ps3disk.c

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