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 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 =
 124                 ps3_system_bus_get_driver_data(&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 =
 173                 ps3_system_bus_get_driver_data(&dev->sbd);
 174         u64 res;
 175
 176         dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
 177
 178         res = lv1_storage_send_device_command(dev->sbd.dev_id,
 179                                               LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
 180                                               0, &dev->tag);
 181         if (res) {
 182                 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
 183                         __func__, __LINE__, res);
 184                 __blk_end_request_all(req, -EIO);
 185                 return 0;
 186         }
 187
 188         priv->req = req;
 189         return 1;
 190 }
 191
 192 static void ps3disk_do_request(struct ps3_storage_device *dev,
 193                                struct request_queue *q)
 194 {
 195         struct request *req;
 196
 197         dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
 198
 199         while ((req = blk_fetch_request(q))) {
 200                 if (blk_fs_request(req)) {
 201                         if (ps3disk_submit_request_sg(dev, req))
 202                                 break;
 203                 } else if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
 204                            req->cmd[0] == REQ_LB_OP_FLUSH) {
 205                         if (ps3disk_submit_flush_request(dev, req))
 206                                 break;
 207                 } else {
 208                         blk_dump_rq_flags(req, DEVICE_NAME " bad request");
 209                         __blk_end_request_all(req, -EIO);
 210                         continue;
 211                 }
 212         }
 213 }
 214
 215 static void ps3disk_request(struct request_queue *q)
 216 {
 217         struct ps3_storage_device *dev = q->queuedata;
 218         struct ps3disk_private *priv =
 219                 ps3_system_bus_get_driver_data(&dev->sbd);
 220
 221         if (priv->req) {
 222                 dev_dbg(&dev->sbd.core, "%s:%u busy\n", __func__, __LINE__);
 223                 return;
 224         }
 225
 226         ps3disk_do_request(dev, q);
 227 }
 228
 229 static irqreturn_t ps3disk_interrupt(int irq, void *data)
 230 {
 231         struct ps3_storage_device *dev = data;
 232         struct ps3disk_private *priv;
 233         struct request *req;
 234         int res, read, error;
 235         u64 tag, status;
 236         const char *op;
 237
 238         res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
 239
 240         if (tag != dev->tag)
 241                 dev_err(&dev->sbd.core,
 242                         "%s:%u: tag mismatch, got %llx, expected %llx\n",
 243                         __func__, __LINE__, tag, dev->tag);
 244
 245         if (res) {
 246                 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
 247                         __func__, __LINE__, res, status);
 248                 return IRQ_HANDLED;
 249         }
 250
 251         priv = ps3_system_bus_get_driver_data(&dev->sbd);
 252         req = priv->req;
 253         if (!req) {
 254                 dev_dbg(&dev->sbd.core,
 255                         "%s:%u non-block layer request completed\n", __func__,
 256                         __LINE__);
 257                 dev->lv1_status = status;
 258                 complete(&dev->done);
 259                 return IRQ_HANDLED;
 260         }
 261
 262         if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
 263             req->cmd[0] == REQ_LB_OP_FLUSH) {
 264                 read = 0;
 265                 op = "flush";
 266         } else {
 267                 read = !rq_data_dir(req);
 268                 op = read ? "read" : "write";
 269         }
 270         if (status) {
 271                 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
 272                         __LINE__, op, status);
 273                 error = -EIO;
 274         } else {
 275                 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
 276                         __LINE__, op);
 277                 error = 0;
 278                 if (read)
 279                         ps3disk_scatter_gather(dev, req, 0);
 280         }
 281
 282         spin_lock(&priv->lock);
 283         __blk_end_request_all(req, error);
 284         priv->req = NULL;
 285         ps3disk_do_request(dev, priv->queue);
 286         spin_unlock(&priv->lock);
 287
 288         return IRQ_HANDLED;
 289 }
 290
 291 static int ps3disk_sync_cache(struct ps3_storage_device *dev)
 292 {
 293         u64 res;
 294
 295         dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__);
 296
 297         res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0);
 298         if (res) {
 299                 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
 300                         __func__, __LINE__, res);
 301                 return -EIO;
 302         }
 303         return 0;
 304 }
 305
 306
 307 /* ATA helpers copied from drivers/ata/libata-core.c */
 308
 309 static void swap_buf_le16(u16 *buf, unsigned int buf_words)
 310 {
 311 #ifdef __BIG_ENDIAN
 312         unsigned int i;
 313
 314         for (i = 0; i < buf_words; i++)
 315                 buf[i] = le16_to_cpu(buf[i]);
 316 #endif /* __BIG_ENDIAN */
 317 }
 318
 319 static u64 ata_id_n_sectors(const u16 *id)
 320 {
 321         if (ata_id_has_lba(id)) {
 322                 if (ata_id_has_lba48(id))
 323                         return ata_id_u64(id, 100);
 324                 else
 325                         return ata_id_u32(id, 60);
 326         } else {
 327                 if (ata_id_current_chs_valid(id))
 328                         return ata_id_u32(id, 57);
 329                 else
 330                         return id[1] * id[3] * id[6];
 331         }
 332 }
 333
 334 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs,
 335                           unsigned int len)
 336 {
 337         unsigned int c;
 338
 339         while (len > 0) {
 340                 c = id[ofs] >> 8;
 341                 *s = c;
 342                 s++;
 343
 344                 c = id[ofs] & 0xff;
 345                 *s = c;
 346                 s++;
 347
 348                 ofs++;
 349                 len -= 2;
 350         }
 351 }
 352
 353 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs,
 354                             unsigned int len)
 355 {
 356         unsigned char *p;
 357
 358         WARN_ON(!(len & 1));
 359
 360         ata_id_string(id, s, ofs, len - 1);
 361
 362         p = s + strnlen(s, len - 1);
 363         while (p > s && p[-1] == ' ')
 364                 p--;
 365         *p = '\0';
 366 }
 367
 368 static int ps3disk_identify(struct ps3_storage_device *dev)
 369 {
 370         struct ps3disk_private *priv =
 371                 ps3_system_bus_get_driver_data(&dev->sbd);
 372         struct lv1_ata_cmnd_block ata_cmnd;
 373         u16 *id = dev->bounce_buf;
 374         u64 res;
 375
 376         dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__);
 377
 378         memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block));
 379         ata_cmnd.command = ATA_CMD_ID_ATA;
 380         ata_cmnd.sector_count = 1;
 381         ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2;
 382         ata_cmnd.buffer = dev->bounce_lpar;
 383         ata_cmnd.proto = PIO_DATA_IN_PROTO;
 384         ata_cmnd.in_out = DIR_READ;
 385
 386         res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND,
 387                                    ps3_mm_phys_to_lpar(__pa(&ata_cmnd)),
 388                                    sizeof(ata_cmnd), ata_cmnd.buffer,
 389                                    ata_cmnd.arglen);
 390         if (res) {
 391                 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%llx\n",
 392                         __func__, __LINE__, res);
 393                 return -EIO;
 394         }
 395
 396         swap_buf_le16(id, ATA_ID_WORDS);
 397
 398         /* All we're interested in are raw capacity and model name */
 399         priv->raw_capacity = ata_id_n_sectors(id);
 400         ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model));
 401         return 0;
 402 }
 403
 404 static void ps3disk_prepare_flush(struct request_queue *q, struct request *req)
 405 {
 406         struct ps3_storage_device *dev = q->queuedata;
 407
 408         dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
 409
 410         req->cmd_type = REQ_TYPE_LINUX_BLOCK;
 411         req->cmd[0] = REQ_LB_OP_FLUSH;
 412 }
 413
 414 static unsigned long ps3disk_mask;
 415
 416 static DEFINE_MUTEX(ps3disk_mask_mutex);
 417
 418 static int __devinit ps3disk_probe(struct ps3_system_bus_device *_dev)
 419 {
 420         struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 421         struct ps3disk_private *priv;
 422         int error;
 423         unsigned int devidx;
 424         struct request_queue *queue;
 425         struct gendisk *gendisk;
 426
 427         if (dev->blk_size < 512) {
 428                 dev_err(&dev->sbd.core,
 429                         "%s:%u: cannot handle block size %llu\n", __func__,
 430                         __LINE__, dev->blk_size);
 431                 return -EINVAL;
 432         }
 433
 434         BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
 435         mutex_lock(&ps3disk_mask_mutex);
 436         devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
 437         if (devidx >= PS3DISK_MAX_DISKS) {
 438                 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
 439                         __LINE__);
 440                 mutex_unlock(&ps3disk_mask_mutex);
 441                 return -ENOSPC;
 442         }
 443         __set_bit(devidx, &ps3disk_mask);
 444         mutex_unlock(&ps3disk_mask_mutex);
 445
 446         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 447         if (!priv) {
 448                 error = -ENOMEM;
 449                 goto fail;
 450         }
 451
 452         ps3_system_bus_set_driver_data(_dev, priv);
 453         spin_lock_init(&priv->lock);
 454
 455         dev->bounce_size = BOUNCE_SIZE;
 456         dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
 457         if (!dev->bounce_buf) {
 458                 error = -ENOMEM;
 459                 goto fail_free_priv;
 460         }
 461
 462         error = ps3stor_setup(dev, ps3disk_interrupt);
 463         if (error)
 464                 goto fail_free_bounce;
 465
 466         ps3disk_identify(dev);
 467
 468         queue = blk_init_queue(ps3disk_request, &priv->lock);
 469         if (!queue) {
 470                 dev_err(&dev->sbd.core, "%s:%u: blk_init_queue failed\n",
 471                         __func__, __LINE__);
 472                 error = -ENOMEM;
 473                 goto fail_teardown;
 474         }
 475
 476         priv->queue = queue;
 477         queue->queuedata = dev;
 478
 479         blk_queue_bounce_limit(queue, BLK_BOUNCE_HIGH);
 480
 481         blk_queue_max_sectors(queue, dev->bounce_size >> 9);
 482         blk_queue_segment_boundary(queue, -1UL);
 483         blk_queue_dma_alignment(queue, dev->blk_size-1);
 484         blk_queue_logical_block_size(queue, dev->blk_size);
 485
 486         blk_queue_ordered(queue, QUEUE_ORDERED_DRAIN_FLUSH,
 487                           ps3disk_prepare_flush);
 488
 489         blk_queue_max_phys_segments(queue, -1);
 490         blk_queue_max_hw_segments(queue, -1);
 491         blk_queue_max_segment_size(queue, dev->bounce_size);
 492
 493         gendisk = alloc_disk(PS3DISK_MINORS);
 494         if (!gendisk) {
 495                 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
 496                         __LINE__);
 497                 error = -ENOMEM;
 498                 goto fail_cleanup_queue;
 499         }
 500
 501         priv->gendisk = gendisk;
 502         gendisk->major = ps3disk_major;
 503         gendisk->first_minor = devidx * PS3DISK_MINORS;
 504         gendisk->fops = &ps3disk_fops;
 505         gendisk->queue = queue;
 506         gendisk->private_data = dev;
 507         gendisk->driverfs_dev = &dev->sbd.core;
 508         snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
 509                  devidx+'a');
 510         priv->blocking_factor = dev->blk_size >> 9;
 511         set_capacity(gendisk,
 512                      dev->regions[dev->region_idx].size*priv->blocking_factor);
 513
 514         dev_info(&dev->sbd.core,
 515                  "%s is a %s (%llu MiB total, %lu MiB for OtherOS)\n",
 516                  gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
 517                  get_capacity(gendisk) >> 11);
 518
 519         add_disk(gendisk);
 520         return 0;
 521
 522 fail_cleanup_queue:
 523         blk_cleanup_queue(queue);
 524 fail_teardown:
 525         ps3stor_teardown(dev);
 526 fail_free_bounce:
 527         kfree(dev->bounce_buf);
 528 fail_free_priv:
 529         kfree(priv);
 530         ps3_system_bus_set_driver_data(_dev, NULL);
 531 fail:
 532         mutex_lock(&ps3disk_mask_mutex);
 533         __clear_bit(devidx, &ps3disk_mask);
 534         mutex_unlock(&ps3disk_mask_mutex);
 535         return error;
 536 }
 537
 538 static int ps3disk_remove(struct ps3_system_bus_device *_dev)
 539 {
 540         struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
 541         struct ps3disk_private *priv =
 542                 ps3_system_bus_get_driver_data(&dev->sbd);
 543
 544         mutex_lock(&ps3disk_mask_mutex);
 545         __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
 546                     &ps3disk_mask);
 547         mutex_unlock(&ps3disk_mask_mutex);
 548         del_gendisk(priv->gendisk);
 549         blk_cleanup_queue(priv->queue);
 550         put_disk(priv->gendisk);
 551         dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
 552         ps3disk_sync_cache(dev);
 553         ps3stor_teardown(dev);
 554         kfree(dev->bounce_buf);
 555         kfree(priv);
 556         ps3_system_bus_set_driver_data(_dev, NULL);
 557         return 0;
 558 }
 559
 560 static struct ps3_system_bus_driver ps3disk = {
 561         .match_id       = PS3_MATCH_ID_STOR_DISK,
 562         .core.name      = DEVICE_NAME,
 563         .core.owner     = THIS_MODULE,
 564         .probe          = ps3disk_probe,
 565         .remove         = ps3disk_remove,
 566         .shutdown       = ps3disk_remove,
 567 };
 568
 569
 570 static int __init ps3disk_init(void)
 571 {
 572         int error;
 573
 574         if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
 575                 return -ENODEV;
 576
 577         error = register_blkdev(0, DEVICE_NAME);
 578         if (error <= 0) {
 579                 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
 580                        __LINE__, error);
 581                 return error;
 582         }
 583         ps3disk_major = error;
 584
 585         pr_info("%s:%u: registered block device major %d\n", __func__,
 586                 __LINE__, ps3disk_major);
 587
 588         error = ps3_system_bus_driver_register(&ps3disk);
 589         if (error)
 590                 unregister_blkdev(ps3disk_major, DEVICE_NAME);
 591
 592         return error;
 593 }
 594
 595 static void __exit ps3disk_exit(void)
 596 {
 597         ps3_system_bus_driver_unregister(&ps3disk);
 598         unregister_blkdev(ps3disk_major, DEVICE_NAME);
 599 }
 600
 601 module_init(ps3disk_init);
 602 module_exit(ps3disk_exit);
 603
 604 MODULE_LICENSE("GPL");
 605 MODULE_DESCRIPTION("PS3 Disk Storage Driver");
 606 MODULE_AUTHOR("Sony Corporation");
 607 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);