]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/block/ps3disk.c
Merge branches 'for-4.11/upstream-fixes', 'for-4.12/accutouch', 'for-4.12/cp2112...
[mirror_ubuntu-artful-kernel.git] / drivers / block / ps3disk.c
CommitLineData
c6131fa5
GU
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>
5a0e3ad6 23#include <linux/slab.h>
0c8d44f2 24#include <linux/module.h>
c6131fa5
GU
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
42struct ps3disk_private {
43 spinlock_t lock; /* Request queue spinlock */
44 struct request_queue *queue;
45 struct gendisk *gendisk;
46 unsigned int blocking_factor;
47 struct request *req;
48 u64 raw_capacity;
49 unsigned char model[ATA_ID_PROD_LEN+1];
50};
51
52
53#define LV1_STORAGE_SEND_ATA_COMMAND (2)
54#define LV1_STORAGE_ATA_HDDOUT (0x23)
55
56struct lv1_ata_cmnd_block {
57 u16 features;
58 u16 sector_count;
59 u16 LBA_low;
60 u16 LBA_mid;
61 u16 LBA_high;
62 u8 device;
63 u8 command;
64 u32 is_ext;
65 u32 proto;
66 u32 in_out;
67 u32 size;
68 u64 buffer;
69 u32 arglen;
70};
71
72enum lv1_ata_proto {
73 NON_DATA_PROTO = 0,
74 PIO_DATA_IN_PROTO = 1,
75 PIO_DATA_OUT_PROTO = 2,
76 DMA_PROTO = 3
77};
78
79enum lv1_ata_in_out {
80 DIR_WRITE = 0, /* memory -> device */
81 DIR_READ = 1 /* device -> memory */
82};
83
84static int ps3disk_major;
85
86
83d5cde4 87static const struct block_device_operations ps3disk_fops = {
c6131fa5
GU
88 .owner = THIS_MODULE,
89};
90
91
92static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
93 struct request *req, int gather)
94{
95 unsigned int offset = 0;
5705f702 96 struct req_iterator iter;
7988613b 97 struct bio_vec bvec;
5705f702 98 unsigned int i = 0;
c6131fa5
GU
99 size_t size;
100 void *buf;
101
5705f702
N
102 rq_for_each_segment(bvec, req, iter) {
103 unsigned long flags;
458b76ed
KO
104 dev_dbg(&dev->sbd.core, "%s:%u: bio %u: %u sectors from %lu\n",
105 __func__, __LINE__, i, bio_sectors(iter.bio),
106 iter.bio->bi_iter.bi_sector);
5705f702 107
7988613b
KO
108 size = bvec.bv_len;
109 buf = bvec_kmap_irq(&bvec, &flags);
6c92e699
JA
110 if (gather)
111 memcpy(dev->bounce_buf+offset, buf, size);
112 else
113 memcpy(buf, dev->bounce_buf+offset, size);
114 offset += size;
7988613b 115 flush_kernel_dcache_page(bvec.bv_page);
93055c31 116 bvec_kunmap_irq(buf, &flags);
c6131fa5
GU
117 i++;
118 }
119}
120
121static int ps3disk_submit_request_sg(struct ps3_storage_device *dev,
122 struct request *req)
123{
03fa68c2 124 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
125 int write = rq_data_dir(req), res;
126 const char *op = write ? "write" : "read";
127 u64 start_sector, sectors;
128 unsigned int region_id = dev->regions[dev->region_idx].id;
129
130#ifdef DEBUG
131 unsigned int n = 0;
7988613b 132 struct bio_vec bv;
5705f702 133 struct req_iterator iter;
c6131fa5 134
5705f702 135 rq_for_each_segment(bv, req, iter)
c6131fa5
GU
136 n++;
137 dev_dbg(&dev->sbd.core,
83096ebf
TH
138 "%s:%u: %s req has %u bvecs for %u sectors\n",
139 __func__, __LINE__, op, n, blk_rq_sectors(req));
c6131fa5
GU
140#endif
141
83096ebf
TH
142 start_sector = blk_rq_pos(req) * priv->blocking_factor;
143 sectors = blk_rq_sectors(req) * priv->blocking_factor;
e377c6e2 144 dev_dbg(&dev->sbd.core, "%s:%u: %s %llu sectors starting at %llu\n",
c6131fa5
GU
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);
10e1e629 161 __blk_end_request_all(req, -EIO);
c6131fa5
GU
162 return 0;
163 }
164
165 priv->req = req;
166 return 1;
167}
168
169static int ps3disk_submit_flush_request(struct ps3_storage_device *dev,
170 struct request *req)
171{
03fa68c2 172 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
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) {
e377c6e2 181 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
c6131fa5 182 __func__, __LINE__, res);
10e1e629 183 __blk_end_request_all(req, -EIO);
c6131fa5
GU
184 return 0;
185 }
186
187 priv->req = req;
188 return 1;
189}
190
191static void ps3disk_do_request(struct ps3_storage_device *dev,
165125e1 192 struct request_queue *q)
c6131fa5
GU
193{
194 struct request *req;
195
196 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
197
9934c8c0 198 while ((req = blk_fetch_request(q))) {
aebf526b
CH
199 switch (req_op(req)) {
200 case REQ_OP_FLUSH:
c6131fa5 201 if (ps3disk_submit_flush_request(dev, req))
aebf526b
CH
202 return;
203 break;
204 case REQ_OP_READ:
205 case REQ_OP_WRITE:
98d8c8f4 206 if (ps3disk_submit_request_sg(dev, req))
aebf526b
CH
207 return;
208 break;
209 default:
c6131fa5 210 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
10e1e629 211 __blk_end_request_all(req, -EIO);
c6131fa5
GU
212 }
213 }
214}
215
165125e1 216static void ps3disk_request(struct request_queue *q)
c6131fa5
GU
217{
218 struct ps3_storage_device *dev = q->queuedata;
03fa68c2 219 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
220
221 if (priv->req) {
222 dev_dbg(&dev->sbd.core, "%s:%u busy\n", __func__, __LINE__);
223 return;
224 }
225
226 ps3disk_do_request(dev, q);
227}
228
229static irqreturn_t ps3disk_interrupt(int irq, void *data)
230{
231 struct ps3_storage_device *dev = data;
232 struct ps3disk_private *priv;
233 struct request *req;
f01ab252 234 int res, read, error;
c6131fa5 235 u64 tag, status;
c6131fa5
GU
236 const char *op;
237
238 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
239
240 if (tag != dev->tag)
241 dev_err(&dev->sbd.core,
e377c6e2 242 "%s:%u: tag mismatch, got %llx, expected %llx\n",
c6131fa5
GU
243 __func__, __LINE__, tag, dev->tag);
244
245 if (res) {
e377c6e2 246 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
c6131fa5
GU
247 __func__, __LINE__, res, status);
248 return IRQ_HANDLED;
249 }
250
03fa68c2 251 priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
252 req = priv->req;
253 if (!req) {
254 dev_dbg(&dev->sbd.core,
255 "%s:%u non-block layer request completed\n", __func__,
256 __LINE__);
257 dev->lv1_status = status;
258 complete(&dev->done);
259 return IRQ_HANDLED;
260 }
261
3a5e02ce 262 if (req_op(req) == REQ_OP_FLUSH) {
c6131fa5 263 read = 0;
c6131fa5
GU
264 op = "flush";
265 } else {
266 read = !rq_data_dir(req);
c6131fa5
GU
267 op = read ? "read" : "write";
268 }
269 if (status) {
e377c6e2 270 dev_dbg(&dev->sbd.core, "%s:%u: %s failed 0x%llx\n", __func__,
c6131fa5 271 __LINE__, op, status);
f01ab252 272 error = -EIO;
c6131fa5
GU
273 } else {
274 dev_dbg(&dev->sbd.core, "%s:%u: %s completed\n", __func__,
275 __LINE__, op);
f01ab252 276 error = 0;
c6131fa5
GU
277 if (read)
278 ps3disk_scatter_gather(dev, req, 0);
279 }
280
281 spin_lock(&priv->lock);
cd4c34eb 282 __blk_end_request_all(req, error);
c6131fa5
GU
283 priv->req = NULL;
284 ps3disk_do_request(dev, priv->queue);
285 spin_unlock(&priv->lock);
286
287 return IRQ_HANDLED;
288}
289
290static 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) {
e377c6e2 298 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
c6131fa5
GU
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
308static 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
318static 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
333static 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
352static 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
367static int ps3disk_identify(struct ps3_storage_device *dev)
368{
03fa68c2 369 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
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) {
e377c6e2 389 dev_err(&dev->sbd.core, "%s:%u: identify disk failed 0x%llx\n",
c6131fa5
GU
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
c6131fa5
GU
402static unsigned long ps3disk_mask;
403
404static DEFINE_MUTEX(ps3disk_mask_mutex);
405
8d85fce7 406static int ps3disk_probe(struct ps3_system_bus_device *_dev)
c6131fa5
GU
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,
e377c6e2 417 "%s:%u: cannot handle block size %llu\n", __func__,
c6131fa5
GU
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
03fa68c2 440 ps3_system_bus_set_drvdata(_dev, priv);
c6131fa5
GU
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_init_queue(ps3disk_request, &priv->lock);
457 if (!queue) {
458 dev_err(&dev->sbd.core, "%s:%u: blk_init_queue failed\n",
459 __func__, __LINE__);
460 error = -ENOMEM;
461 goto fail_teardown;
462 }
463
464 priv->queue = queue;
465 queue->queuedata = dev;
466
467 blk_queue_bounce_limit(queue, BLK_BOUNCE_HIGH);
468
086fa5ff 469 blk_queue_max_hw_sectors(queue, dev->bounce_size >> 9);
c6131fa5
GU
470 blk_queue_segment_boundary(queue, -1UL);
471 blk_queue_dma_alignment(queue, dev->blk_size-1);
e1defc4f 472 blk_queue_logical_block_size(queue, dev->blk_size);
c6131fa5 473
12c95f13 474 blk_queue_write_cache(queue, true, false);
c6131fa5 475
8a78362c 476 blk_queue_max_segments(queue, -1);
c6131fa5
GU
477 blk_queue_max_segment_size(queue, dev->bounce_size);
478
479 gendisk = alloc_disk(PS3DISK_MINORS);
480 if (!gendisk) {
481 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
482 __LINE__);
483 error = -ENOMEM;
484 goto fail_cleanup_queue;
485 }
486
487 priv->gendisk = gendisk;
488 gendisk->major = ps3disk_major;
489 gendisk->first_minor = devidx * PS3DISK_MINORS;
490 gendisk->fops = &ps3disk_fops;
491 gendisk->queue = queue;
492 gendisk->private_data = dev;
c6131fa5
GU
493 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
494 devidx+'a');
495 priv->blocking_factor = dev->blk_size >> 9;
496 set_capacity(gendisk,
497 dev->regions[dev->region_idx].size*priv->blocking_factor);
498
499 dev_info(&dev->sbd.core,
e377c6e2 500 "%s is a %s (%llu MiB total, %lu MiB for OtherOS)\n",
c6131fa5
GU
501 gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
502 get_capacity(gendisk) >> 11);
503
0d52c756 504 device_add_disk(&dev->sbd.core, gendisk);
c6131fa5
GU
505 return 0;
506
507fail_cleanup_queue:
508 blk_cleanup_queue(queue);
509fail_teardown:
510 ps3stor_teardown(dev);
511fail_free_bounce:
512 kfree(dev->bounce_buf);
513fail_free_priv:
514 kfree(priv);
03fa68c2 515 ps3_system_bus_set_drvdata(_dev, NULL);
c6131fa5
GU
516fail:
517 mutex_lock(&ps3disk_mask_mutex);
518 __clear_bit(devidx, &ps3disk_mask);
519 mutex_unlock(&ps3disk_mask_mutex);
520 return error;
521}
522
523static int ps3disk_remove(struct ps3_system_bus_device *_dev)
524{
525 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
03fa68c2 526 struct ps3disk_private *priv = ps3_system_bus_get_drvdata(&dev->sbd);
c6131fa5
GU
527
528 mutex_lock(&ps3disk_mask_mutex);
f331c029 529 __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
c6131fa5
GU
530 &ps3disk_mask);
531 mutex_unlock(&ps3disk_mask_mutex);
532 del_gendisk(priv->gendisk);
533 blk_cleanup_queue(priv->queue);
534 put_disk(priv->gendisk);
535 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
536 ps3disk_sync_cache(dev);
537 ps3stor_teardown(dev);
538 kfree(dev->bounce_buf);
539 kfree(priv);
03fa68c2 540 ps3_system_bus_set_drvdata(_dev, NULL);
c6131fa5
GU
541 return 0;
542}
543
544static struct ps3_system_bus_driver ps3disk = {
545 .match_id = PS3_MATCH_ID_STOR_DISK,
546 .core.name = DEVICE_NAME,
547 .core.owner = THIS_MODULE,
548 .probe = ps3disk_probe,
549 .remove = ps3disk_remove,
550 .shutdown = ps3disk_remove,
551};
552
553
554static int __init ps3disk_init(void)
555{
556 int error;
557
558 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
559 return -ENODEV;
560
561 error = register_blkdev(0, DEVICE_NAME);
562 if (error <= 0) {
563 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
564 __LINE__, error);
565 return error;
566 }
567 ps3disk_major = error;
568
569 pr_info("%s:%u: registered block device major %d\n", __func__,
570 __LINE__, ps3disk_major);
571
572 error = ps3_system_bus_driver_register(&ps3disk);
573 if (error)
574 unregister_blkdev(ps3disk_major, DEVICE_NAME);
575
576 return error;
577}
578
579static void __exit ps3disk_exit(void)
580{
581 ps3_system_bus_driver_unregister(&ps3disk);
582 unregister_blkdev(ps3disk_major, DEVICE_NAME);
583}
584
585module_init(ps3disk_init);
586module_exit(ps3disk_exit);
587
588MODULE_LICENSE("GPL");
589MODULE_DESCRIPTION("PS3 Disk Storage Driver");
590MODULE_AUTHOR("Sony Corporation");
591MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);