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