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 = dev->sbd.core.driver_data; 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 %lu sectors %lu hard sectors\n", 138 __func__, __LINE__, op, n, req->nr_sectors, 139 req->hard_nr_sectors); 140 #endif 141 142 start_sector = req->sector * priv->blocking_factor; 143 sectors = req->nr_sectors * priv->blocking_factor; 144 dev_dbg(&dev->sbd.core, "%s:%u: %s %lu sectors starting at %lu\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 end_request(req, 0); 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 = dev->sbd.core.driver_data; 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%lx\n", 182 __func__, __LINE__, res); 183 end_request(req, 0); 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 = elv_next_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 end_request(req, 0); 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 = dev->sbd.core.driver_data; 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 unsigned long num_sectors; 235 const char *op; 236 237 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status); 238 239 if (tag != dev->tag) 240 dev_err(&dev->sbd.core, 241 "%s:%u: tag mismatch, got %lx, expected %lx\n", 242 __func__, __LINE__, tag, dev->tag); 243 244 if (res) { 245 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%lx\n", 246 __func__, __LINE__, res, status); 247 return IRQ_HANDLED; 248 } 249 250 priv = dev->sbd.core.driver_data; 251 req = priv->req; 252 if (!req) { 253 dev_dbg(&dev->sbd.core, 254 "%s:%u non-block layer request completed\n", __func__, 255 __LINE__); 256 dev->lv1_status = status; 257 complete(&dev->done); 258 return IRQ_HANDLED; 259 } 260 261 if (req->cmd_type == REQ_TYPE_LINUX_BLOCK && 262 req->cmd[0] == REQ_LB_OP_FLUSH) { 263 read = 0; 264 num_sectors = req->hard_cur_sectors; 265 op = "flush"; 266 } else { 267 read = !rq_data_dir(req); 268 num_sectors = req->nr_sectors; 269 op = read ? "read" : "write"; 270 } 271 if (status) { 272 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%lx\n", __func__, 273 __LINE__, op, status); 274 error = -EIO; 275 } else { 276 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__, 277 __LINE__, op); 278 error = 0; 279 if (read) 280 ps3disk_scatter_gather(dev, req, 0); 281 } 282 283 spin_lock(&priv->lock); 284 __blk_end_request(req, error, num_sectors << 9); 285 priv->req = NULL; 286 ps3disk_do_request(dev, priv->queue); 287 spin_unlock(&priv->lock); 288 289 return IRQ_HANDLED; 290 } 291 292 static int ps3disk_sync_cache(struct ps3_storage_device *dev) 293 { 294 u64 res; 295 296 dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__); 297 298 res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0); 299 if (res) { 300 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%lx\n", 301 __func__, __LINE__, res); 302 return -EIO; 303 } 304 return 0; 305 } 306 307 308 /* ATA helpers copied from drivers/ata/libata-core.c */ 309 310 static void swap_buf_le16(u16 *buf, unsigned int buf_words) 311 { 312 #ifdef __BIG_ENDIAN 313 unsigned int i; 314 315 for (i = 0; i < buf_words; i++) 316 buf[i] = le16_to_cpu(buf[i]); 317 #endif /* __BIG_ENDIAN */ 318 } 319 320 static u64 ata_id_n_sectors(const u16 *id) 321 { 322 if (ata_id_has_lba(id)) { 323 if (ata_id_has_lba48(id)) 324 return ata_id_u64(id, 100); 325 else 326 return ata_id_u32(id, 60); 327 } else { 328 if (ata_id_current_chs_valid(id)) 329 return ata_id_u32(id, 57); 330 else 331 return id[1] * id[3] * id[6]; 332 } 333 } 334 335 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs, 336 unsigned int len) 337 { 338 unsigned int c; 339 340 while (len > 0) { 341 c = id[ofs] >> 8; 342 *s = c; 343 s++; 344 345 c = id[ofs] & 0xff; 346 *s = c; 347 s++; 348 349 ofs++; 350 len -= 2; 351 } 352 } 353 354 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs, 355 unsigned int len) 356 { 357 unsigned char *p; 358 359 WARN_ON(!(len & 1)); 360 361 ata_id_string(id, s, ofs, len - 1); 362 363 p = s + strnlen(s, len - 1); 364 while (p > s && p[-1] == ' ') 365 p--; 366 *p = '\0'; 367 } 368 369 static int ps3disk_identify(struct ps3_storage_device *dev) 370 { 371 struct ps3disk_private *priv = dev->sbd.core.driver_data; 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%lx\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 %lu\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 dev->sbd.core.driver_data = 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_hardsect_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 (%lu 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 dev->sbd.core.driver_data = 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 = dev->sbd.core.driver_data; 542 543 mutex_lock(&ps3disk_mask_mutex); 544 __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS, 545 &ps3disk_mask); 546 mutex_unlock(&ps3disk_mask_mutex); 547 del_gendisk(priv->gendisk); 548 blk_cleanup_queue(priv->queue); 549 put_disk(priv->gendisk); 550 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n"); 551 ps3disk_sync_cache(dev); 552 ps3stor_teardown(dev); 553 kfree(dev->bounce_buf); 554 kfree(priv); 555 dev->sbd.core.driver_data = NULL; 556 return 0; 557 } 558 559 static struct ps3_system_bus_driver ps3disk = { 560 .match_id = PS3_MATCH_ID_STOR_DISK, 561 .core.name = DEVICE_NAME, 562 .core.owner = THIS_MODULE, 563 .probe = ps3disk_probe, 564 .remove = ps3disk_remove, 565 .shutdown = ps3disk_remove, 566 }; 567 568 569 static int __init ps3disk_init(void) 570 { 571 int error; 572 573 if (!firmware_has_feature(FW_FEATURE_PS3_LV1)) 574 return -ENODEV; 575 576 error = register_blkdev(0, DEVICE_NAME); 577 if (error <= 0) { 578 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__, 579 __LINE__, error); 580 return error; 581 } 582 ps3disk_major = error; 583 584 pr_info("%s:%u: registered block device major %d\n", __func__, 585 __LINE__, ps3disk_major); 586 587 error = ps3_system_bus_driver_register(&ps3disk); 588 if (error) 589 unregister_blkdev(ps3disk_major, DEVICE_NAME); 590 591 return error; 592 } 593 594 static void __exit ps3disk_exit(void) 595 { 596 ps3_system_bus_driver_unregister(&ps3disk); 597 unregister_blkdev(ps3disk_major, DEVICE_NAME); 598 } 599 600 module_init(ps3disk_init); 601 module_exit(ps3disk_exit); 602 603 MODULE_LICENSE("GPL"); 604 MODULE_DESCRIPTION("PS3 Disk Storage Driver"); 605 MODULE_AUTHOR("Sony Corporation"); 606 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK); 607