ps3disk.c 14 KB

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