ps3disk.c 13 KB

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