ps3disk.c 13 KB

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