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