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_FLUSH) { 203 if (ps3disk_submit_flush_request(dev, req)) 204 break; 205 } else { 206 blk_dump_rq_flags(req, DEVICE_NAME " bad request"); 207 end_request(req, 0); 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 = dev->sbd.core.driver_data; 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 unsigned long num_sectors; 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 %lx, expected %lx\n", 241 __func__, __LINE__, tag, dev->tag); 242 243 if (res) { 244 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%lx\n", 245 __func__, __LINE__, res, status); 246 return IRQ_HANDLED; 247 } 248 249 priv = dev->sbd.core.driver_data; 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_FLUSH) { 261 read = 0; 262 num_sectors = req->hard_cur_sectors; 263 op = "flush"; 264 } else { 265 read = !rq_data_dir(req); 266 num_sectors = req->nr_sectors; 267 op = read ? "read" : "write"; 268 } 269 if (status) { 270 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%lx\n", __func__, 271 __LINE__, op, status); 272 error = -EIO; 273 } else { 274 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__, 275 __LINE__, op); 276 error = 0; 277 if (read) 278 ps3disk_scatter_gather(dev, req, 0); 279 } 280 281 spin_lock(&priv->lock); 282 __blk_end_request(req, error, num_sectors << 9); 283 priv->req = NULL; 284 ps3disk_do_request(dev, priv->queue); 285 spin_unlock(&priv->lock); 286 287 return IRQ_HANDLED; 288 } 289 290 static int ps3disk_sync_cache(struct ps3_storage_device *dev) 291 { 292 u64 res; 293 294 dev_dbg(&dev->sbd.core, "%s:%u: sync cache\n", __func__, __LINE__); 295 296 res = ps3stor_send_command(dev, LV1_STORAGE_ATA_HDDOUT, 0, 0, 0, 0); 297 if (res) { 298 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%lx\n", 299 __func__, __LINE__, res); 300 return -EIO; 301 } 302 return 0; 303 } 304 305 306 /* ATA helpers copied from drivers/ata/libata-core.c */ 307 308 static void swap_buf_le16(u16 *buf, unsigned int buf_words) 309 { 310 #ifdef __BIG_ENDIAN 311 unsigned int i; 312 313 for (i = 0; i < buf_words; i++) 314 buf[i] = le16_to_cpu(buf[i]); 315 #endif /* __BIG_ENDIAN */ 316 } 317 318 static u64 ata_id_n_sectors(const u16 *id) 319 { 320 if (ata_id_has_lba(id)) { 321 if (ata_id_has_lba48(id)) 322 return ata_id_u64(id, 100); 323 else 324 return ata_id_u32(id, 60); 325 } else { 326 if (ata_id_current_chs_valid(id)) 327 return ata_id_u32(id, 57); 328 else 329 return id[1] * id[3] * id[6]; 330 } 331 } 332 333 static void ata_id_string(const u16 *id, unsigned char *s, unsigned int ofs, 334 unsigned int len) 335 { 336 unsigned int c; 337 338 while (len > 0) { 339 c = id[ofs] >> 8; 340 *s = c; 341 s++; 342 343 c = id[ofs] & 0xff; 344 *s = c; 345 s++; 346 347 ofs++; 348 len -= 2; 349 } 350 } 351 352 static void ata_id_c_string(const u16 *id, unsigned char *s, unsigned int ofs, 353 unsigned int len) 354 { 355 unsigned char *p; 356 357 WARN_ON(!(len & 1)); 358 359 ata_id_string(id, s, ofs, len - 1); 360 361 p = s + strnlen(s, len - 1); 362 while (p > s && p[-1] == ' ') 363 p--; 364 *p = '\0'; 365 } 366 367 static int ps3disk_identify(struct ps3_storage_device *dev) 368 { 369 struct ps3disk_private *priv = dev->sbd.core.driver_data; 370 struct lv1_ata_cmnd_block ata_cmnd; 371 u16 *id = dev->bounce_buf; 372 u64 res; 373 374 dev_dbg(&dev->sbd.core, "%s:%u: identify disk\n", __func__, __LINE__); 375 376 memset(&ata_cmnd, 0, sizeof(struct lv1_ata_cmnd_block)); 377 ata_cmnd.command = ATA_CMD_ID_ATA; 378 ata_cmnd.sector_count = 1; 379 ata_cmnd.size = ata_cmnd.arglen = ATA_ID_WORDS * 2; 380 ata_cmnd.buffer = dev->bounce_lpar; 381 ata_cmnd.proto = PIO_DATA_IN_PROTO; 382 ata_cmnd.in_out = DIR_READ; 383 384 res = ps3stor_send_command(dev, LV1_STORAGE_SEND_ATA_COMMAND, 385 ps3_mm_phys_to_lpar(__pa(&ata_cmnd)), 386 sizeof(ata_cmnd), ata_cmnd.buffer, 387 ata_cmnd.arglen); 388 if (res) { 389 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%lx\n", 390 __func__, __LINE__, res); 391 return -EIO; 392 } 393 394 swap_buf_le16(id, ATA_ID_WORDS); 395 396 /* All we're interested in are raw capacity and model name */ 397 priv->raw_capacity = ata_id_n_sectors(id); 398 ata_id_c_string(id, priv->model, ATA_ID_PROD, sizeof(priv->model)); 399 return 0; 400 } 401 402 static void ps3disk_prepare_flush(struct request_queue *q, struct request *req) 403 { 404 struct ps3_storage_device *dev = q->queuedata; 405 406 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__); 407 408 req->cmd_type = REQ_TYPE_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 %lu\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 dev->sbd.core.driver_data = 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_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_hardsect_size(queue, dev->blk_size); 482 483 blk_queue_ordered(queue, QUEUE_ORDERED_DRAIN_FLUSH, 484 ps3disk_prepare_flush); 485 486 blk_queue_max_phys_segments(queue, -1); 487 blk_queue_max_hw_segments(queue, -1); 488 blk_queue_max_segment_size(queue, dev->bounce_size); 489 490 gendisk = alloc_disk(PS3DISK_MINORS); 491 if (!gendisk) { 492 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__, 493 __LINE__); 494 error = -ENOMEM; 495 goto fail_cleanup_queue; 496 } 497 498 priv->gendisk = gendisk; 499 gendisk->major = ps3disk_major; 500 gendisk->first_minor = devidx * PS3DISK_MINORS; 501 gendisk->fops = &ps3disk_fops; 502 gendisk->queue = queue; 503 gendisk->private_data = dev; 504 gendisk->driverfs_dev = &dev->sbd.core; 505 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME, 506 devidx+'a'); 507 priv->blocking_factor = dev->blk_size >> 9; 508 set_capacity(gendisk, 509 dev->regions[dev->region_idx].size*priv->blocking_factor); 510 511 dev_info(&dev->sbd.core, 512 "%s is a %s (%lu MiB total, %lu MiB for OtherOS)\n", 513 gendisk->disk_name, priv->model, priv->raw_capacity >> 11, 514 get_capacity(gendisk) >> 11); 515 516 add_disk(gendisk); 517 return 0; 518 519 fail_cleanup_queue: 520 blk_cleanup_queue(queue); 521 fail_teardown: 522 ps3stor_teardown(dev); 523 fail_free_bounce: 524 kfree(dev->bounce_buf); 525 fail_free_priv: 526 kfree(priv); 527 dev->sbd.core.driver_data = NULL; 528 fail: 529 mutex_lock(&ps3disk_mask_mutex); 530 __clear_bit(devidx, &ps3disk_mask); 531 mutex_unlock(&ps3disk_mask_mutex); 532 return error; 533 } 534 535 static int ps3disk_remove(struct ps3_system_bus_device *_dev) 536 { 537 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core); 538 struct ps3disk_private *priv = dev->sbd.core.driver_data; 539 540 mutex_lock(&ps3disk_mask_mutex); 541 __clear_bit(priv->gendisk->first_minor / PS3DISK_MINORS, 542 &ps3disk_mask); 543 mutex_unlock(&ps3disk_mask_mutex); 544 del_gendisk(priv->gendisk); 545 blk_cleanup_queue(priv->queue); 546 put_disk(priv->gendisk); 547 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n"); 548 ps3disk_sync_cache(dev); 549 ps3stor_teardown(dev); 550 kfree(dev->bounce_buf); 551 kfree(priv); 552 dev->sbd.core.driver_data = NULL; 553 return 0; 554 } 555 556 static struct ps3_system_bus_driver ps3disk = { 557 .match_id = PS3_MATCH_ID_STOR_DISK, 558 .core.name = DEVICE_NAME, 559 .core.owner = THIS_MODULE, 560 .probe = ps3disk_probe, 561 .remove = ps3disk_remove, 562 .shutdown = ps3disk_remove, 563 }; 564 565 566 static int __init ps3disk_init(void) 567 { 568 int error; 569 570 if (!firmware_has_feature(FW_FEATURE_PS3_LV1)) 571 return -ENODEV; 572 573 error = register_blkdev(0, DEVICE_NAME); 574 if (error <= 0) { 575 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__, 576 __LINE__, error); 577 return error; 578 } 579 ps3disk_major = error; 580 581 pr_info("%s:%u: registered block device major %d\n", __func__, 582 __LINE__, ps3disk_major); 583 584 error = ps3_system_bus_driver_register(&ps3disk); 585 if (error) 586 unregister_blkdev(ps3disk_major, DEVICE_NAME); 587 588 return error; 589 } 590 591 static void __exit ps3disk_exit(void) 592 { 593 ps3_system_bus_driver_unregister(&ps3disk); 594 unregister_blkdev(ps3disk_major, DEVICE_NAME); 595 } 596 597 module_init(ps3disk_init); 598 module_exit(ps3disk_exit); 599 600 MODULE_LICENSE("GPL"); 601 MODULE_DESCRIPTION("PS3 Disk Storage Driver"); 602 MODULE_AUTHOR("Sony Corporation"); 603 MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK); 604