]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/block/ps3disk.c
ps3disk: dequeue in-flight request
[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>
23
24#include <asm/lv1call.h>
25#include <asm/ps3stor.h>
26#include <asm/firmware.h>
27
28
29#define DEVICE_NAME "ps3disk"
30
31#define BOUNCE_SIZE (64*1024)
32
33#define PS3DISK_MAX_DISKS 16
34#define PS3DISK_MINORS 16
35
36
37#define PS3DISK_NAME "ps3d%c"
38
39
40struct ps3disk_private {
41 spinlock_t lock; /* Request queue spinlock */
42 struct request_queue *queue;
43 struct gendisk *gendisk;
44 unsigned int blocking_factor;
45 struct request *req;
46 u64 raw_capacity;
47 unsigned char model[ATA_ID_PROD_LEN+1];
48};
49
50
51#define LV1_STORAGE_SEND_ATA_COMMAND (2)
52#define LV1_STORAGE_ATA_HDDOUT (0x23)
53
54struct lv1_ata_cmnd_block {
55 u16 features;
56 u16 sector_count;
57 u16 LBA_low;
58 u16 LBA_mid;
59 u16 LBA_high;
60 u8 device;
61 u8 command;
62 u32 is_ext;
63 u32 proto;
64 u32 in_out;
65 u32 size;
66 u64 buffer;
67 u32 arglen;
68};
69
70enum lv1_ata_proto {
71 NON_DATA_PROTO = 0,
72 PIO_DATA_IN_PROTO = 1,
73 PIO_DATA_OUT_PROTO = 2,
74 DMA_PROTO = 3
75};
76
77enum lv1_ata_in_out {
78 DIR_WRITE = 0, /* memory -> device */
79 DIR_READ = 1 /* device -> memory */
80};
81
82static int ps3disk_major;
83
84
85static struct block_device_operations ps3disk_fops = {
86 .owner = THIS_MODULE,
87};
88
89
90static void ps3disk_scatter_gather(struct ps3_storage_device *dev,
91 struct request *req, int gather)
92{
93 unsigned int offset = 0;
5705f702 94 struct req_iterator iter;
c6131fa5 95 struct bio_vec *bvec;
5705f702 96 unsigned int i = 0;
c6131fa5
GU
97 size_t size;
98 void *buf;
99
5705f702
N
100 rq_for_each_segment(bvec, req, iter) {
101 unsigned long flags;
c6131fa5
GU
102 dev_dbg(&dev->sbd.core,
103 "%s:%u: bio %u: %u segs %u sectors from %lu\n",
5705f702 104 __func__, __LINE__, i, bio_segments(iter.bio),
31e103c5 105 bio_sectors(iter.bio), iter.bio->bi_sector);
5705f702 106
6c92e699
JA
107 size = bvec->bv_len;
108 buf = bvec_kmap_irq(bvec, &flags);
109 if (gather)
110 memcpy(dev->bounce_buf+offset, buf, size);
111 else
112 memcpy(buf, dev->bounce_buf+offset, size);
113 offset += size;
114 flush_kernel_dcache_page(bvec->bv_page);
115 bvec_kunmap_irq(bvec, &flags);
c6131fa5
GU
116 i++;
117 }
118}
119
120static int ps3disk_submit_request_sg(struct ps3_storage_device *dev,
121 struct request *req)
122{
123 struct ps3disk_private *priv = dev->sbd.core.driver_data;
124 int write = rq_data_dir(req), res;
125 const char *op = write ? "write" : "read";
126 u64 start_sector, sectors;
127 unsigned int region_id = dev->regions[dev->region_idx].id;
128
129#ifdef DEBUG
130 unsigned int n = 0;
5705f702
N
131 struct bio_vec *bv;
132 struct req_iterator iter;
c6131fa5 133
5705f702 134 rq_for_each_segment(bv, req, iter)
c6131fa5
GU
135 n++;
136 dev_dbg(&dev->sbd.core,
83096ebf
TH
137 "%s:%u: %s req has %u bvecs for %u sectors\n",
138 __func__, __LINE__, op, n, blk_rq_sectors(req));
c6131fa5
GU
139#endif
140
83096ebf
TH
141 start_sector = blk_rq_pos(req) * priv->blocking_factor;
142 sectors = blk_rq_sectors(req) * priv->blocking_factor;
e377c6e2 143 dev_dbg(&dev->sbd.core, "%s:%u: %s %llu sectors starting at %llu\n",
c6131fa5
GU
144 __func__, __LINE__, op, sectors, start_sector);
145
146 if (write) {
147 ps3disk_scatter_gather(dev, req, 1);
148
149 res = lv1_storage_write(dev->sbd.dev_id, region_id,
150 start_sector, sectors, 0,
151 dev->bounce_lpar, &dev->tag);
152 } else {
153 res = lv1_storage_read(dev->sbd.dev_id, region_id,
154 start_sector, sectors, 0,
155 dev->bounce_lpar, &dev->tag);
156 }
157 if (res) {
158 dev_err(&dev->sbd.core, "%s:%u: %s failed %d\n", __func__,
159 __LINE__, op, res);
10e1e629 160 __blk_end_request_all(req, -EIO);
c6131fa5
GU
161 return 0;
162 }
163
164 priv->req = req;
165 return 1;
166}
167
168static int ps3disk_submit_flush_request(struct ps3_storage_device *dev,
169 struct request *req)
170{
171 struct ps3disk_private *priv = dev->sbd.core.driver_data;
172 u64 res;
173
174 dev_dbg(&dev->sbd.core, "%s:%u: flush request\n", __func__, __LINE__);
175
176 res = lv1_storage_send_device_command(dev->sbd.dev_id,
177 LV1_STORAGE_ATA_HDDOUT, 0, 0, 0,
178 0, &dev->tag);
179 if (res) {
e377c6e2 180 dev_err(&dev->sbd.core, "%s:%u: sync cache failed 0x%llx\n",
c6131fa5 181 __func__, __LINE__, res);
10e1e629 182 __blk_end_request_all(req, -EIO);
c6131fa5
GU
183 return 0;
184 }
185
186 priv->req = req;
187 return 1;
188}
189
190static void ps3disk_do_request(struct ps3_storage_device *dev,
165125e1 191 struct request_queue *q)
c6131fa5
GU
192{
193 struct request *req;
194
195 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
196
197 while ((req = elv_next_request(q))) {
10e1e629
TH
198 blkdev_dequeue_request(req);
199
c6131fa5
GU
200 if (blk_fs_request(req)) {
201 if (ps3disk_submit_request_sg(dev, req))
202 break;
1a8e2bdd
DW
203 } else if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
204 req->cmd[0] == REQ_LB_OP_FLUSH) {
c6131fa5
GU
205 if (ps3disk_submit_flush_request(dev, req))
206 break;
207 } else {
208 blk_dump_rq_flags(req, DEVICE_NAME " bad request");
10e1e629 209 __blk_end_request_all(req, -EIO);
c6131fa5
GU
210 continue;
211 }
212 }
213}
214
165125e1 215static void ps3disk_request(struct request_queue *q)
c6131fa5
GU
216{
217 struct ps3_storage_device *dev = q->queuedata;
218 struct ps3disk_private *priv = dev->sbd.core.driver_data;
219
220 if (priv->req) {
221 dev_dbg(&dev->sbd.core, "%s:%u busy\n", __func__, __LINE__);
222 return;
223 }
224
225 ps3disk_do_request(dev, q);
226}
227
228static irqreturn_t ps3disk_interrupt(int irq, void *data)
229{
230 struct ps3_storage_device *dev = data;
231 struct ps3disk_private *priv;
232 struct request *req;
f01ab252 233 int res, read, error;
c6131fa5 234 u64 tag, status;
c6131fa5
GU
235 const char *op;
236
237 res = lv1_storage_get_async_status(dev->sbd.dev_id, &tag, &status);
238
239 if (tag != dev->tag)
240 dev_err(&dev->sbd.core,
e377c6e2 241 "%s:%u: tag mismatch, got %llx, expected %llx\n",
c6131fa5
GU
242 __func__, __LINE__, tag, dev->tag);
243
244 if (res) {
e377c6e2 245 dev_err(&dev->sbd.core, "%s:%u: res=%d status=0x%llx\n",
c6131fa5
GU
246 __func__, __LINE__, res, status);
247 return IRQ_HANDLED;
248 }
249
250 priv = dev->sbd.core.driver_data;
251 req = priv->req;
252 if (!req) {
253 dev_dbg(&dev->sbd.core,
254 "%s:%u non-block layer request completed\n", __func__,
255 __LINE__);
256 dev->lv1_status = status;
257 complete(&dev->done);
258 return IRQ_HANDLED;
259 }
260
1a8e2bdd
DW
261 if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
262 req->cmd[0] == REQ_LB_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{
369 struct ps3disk_private *priv = dev->sbd.core.driver_data;
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
165125e1 402static void ps3disk_prepare_flush(struct request_queue *q, struct request *req)
c6131fa5
GU
403{
404 struct ps3_storage_device *dev = q->queuedata;
405
406 dev_dbg(&dev->sbd.core, "%s:%u\n", __func__, __LINE__);
407
1a8e2bdd
DW
408 req->cmd_type = REQ_TYPE_LINUX_BLOCK;
409 req->cmd[0] = REQ_LB_OP_FLUSH;
c6131fa5
GU
410}
411
c6131fa5
GU
412static unsigned long ps3disk_mask;
413
414static DEFINE_MUTEX(ps3disk_mask_mutex);
415
416static int __devinit ps3disk_probe(struct ps3_system_bus_device *_dev)
417{
418 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
419 struct ps3disk_private *priv;
420 int error;
421 unsigned int devidx;
422 struct request_queue *queue;
423 struct gendisk *gendisk;
424
425 if (dev->blk_size < 512) {
426 dev_err(&dev->sbd.core,
e377c6e2 427 "%s:%u: cannot handle block size %llu\n", __func__,
c6131fa5
GU
428 __LINE__, dev->blk_size);
429 return -EINVAL;
430 }
431
432 BUILD_BUG_ON(PS3DISK_MAX_DISKS > BITS_PER_LONG);
433 mutex_lock(&ps3disk_mask_mutex);
434 devidx = find_first_zero_bit(&ps3disk_mask, PS3DISK_MAX_DISKS);
435 if (devidx >= PS3DISK_MAX_DISKS) {
436 dev_err(&dev->sbd.core, "%s:%u: Too many disks\n", __func__,
437 __LINE__);
438 mutex_unlock(&ps3disk_mask_mutex);
439 return -ENOSPC;
440 }
441 __set_bit(devidx, &ps3disk_mask);
442 mutex_unlock(&ps3disk_mask_mutex);
443
444 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
445 if (!priv) {
446 error = -ENOMEM;
447 goto fail;
448 }
449
450 dev->sbd.core.driver_data = priv;
451 spin_lock_init(&priv->lock);
452
453 dev->bounce_size = BOUNCE_SIZE;
454 dev->bounce_buf = kmalloc(BOUNCE_SIZE, GFP_DMA);
455 if (!dev->bounce_buf) {
456 error = -ENOMEM;
457 goto fail_free_priv;
458 }
459
460 error = ps3stor_setup(dev, ps3disk_interrupt);
461 if (error)
462 goto fail_free_bounce;
463
464 ps3disk_identify(dev);
465
466 queue = blk_init_queue(ps3disk_request, &priv->lock);
467 if (!queue) {
468 dev_err(&dev->sbd.core, "%s:%u: blk_init_queue failed\n",
469 __func__, __LINE__);
470 error = -ENOMEM;
471 goto fail_teardown;
472 }
473
474 priv->queue = queue;
475 queue->queuedata = dev;
476
477 blk_queue_bounce_limit(queue, BLK_BOUNCE_HIGH);
478
479 blk_queue_max_sectors(queue, dev->bounce_size >> 9);
480 blk_queue_segment_boundary(queue, -1UL);
481 blk_queue_dma_alignment(queue, dev->blk_size-1);
482 blk_queue_hardsect_size(queue, dev->blk_size);
483
c6131fa5
GU
484 blk_queue_ordered(queue, QUEUE_ORDERED_DRAIN_FLUSH,
485 ps3disk_prepare_flush);
486
487 blk_queue_max_phys_segments(queue, -1);
488 blk_queue_max_hw_segments(queue, -1);
489 blk_queue_max_segment_size(queue, dev->bounce_size);
490
491 gendisk = alloc_disk(PS3DISK_MINORS);
492 if (!gendisk) {
493 dev_err(&dev->sbd.core, "%s:%u: alloc_disk failed\n", __func__,
494 __LINE__);
495 error = -ENOMEM;
496 goto fail_cleanup_queue;
497 }
498
499 priv->gendisk = gendisk;
500 gendisk->major = ps3disk_major;
501 gendisk->first_minor = devidx * PS3DISK_MINORS;
502 gendisk->fops = &ps3disk_fops;
503 gendisk->queue = queue;
504 gendisk->private_data = dev;
505 gendisk->driverfs_dev = &dev->sbd.core;
506 snprintf(gendisk->disk_name, sizeof(gendisk->disk_name), PS3DISK_NAME,
507 devidx+'a');
508 priv->blocking_factor = dev->blk_size >> 9;
509 set_capacity(gendisk,
510 dev->regions[dev->region_idx].size*priv->blocking_factor);
511
512 dev_info(&dev->sbd.core,
e377c6e2 513 "%s is a %s (%llu MiB total, %lu MiB for OtherOS)\n",
c6131fa5
GU
514 gendisk->disk_name, priv->model, priv->raw_capacity >> 11,
515 get_capacity(gendisk) >> 11);
516
517 add_disk(gendisk);
518 return 0;
519
520fail_cleanup_queue:
521 blk_cleanup_queue(queue);
522fail_teardown:
523 ps3stor_teardown(dev);
524fail_free_bounce:
525 kfree(dev->bounce_buf);
526fail_free_priv:
527 kfree(priv);
528 dev->sbd.core.driver_data = NULL;
529fail:
530 mutex_lock(&ps3disk_mask_mutex);
531 __clear_bit(devidx, &ps3disk_mask);
532 mutex_unlock(&ps3disk_mask_mutex);
533 return error;
534}
535
536static int ps3disk_remove(struct ps3_system_bus_device *_dev)
537{
538 struct ps3_storage_device *dev = to_ps3_storage_device(&_dev->core);
539 struct ps3disk_private *priv = dev->sbd.core.driver_data;
540
541 mutex_lock(&ps3disk_mask_mutex);
f331c029 542 __clear_bit(MINOR(disk_devt(priv->gendisk)) / PS3DISK_MINORS,
c6131fa5
GU
543 &ps3disk_mask);
544 mutex_unlock(&ps3disk_mask_mutex);
545 del_gendisk(priv->gendisk);
546 blk_cleanup_queue(priv->queue);
547 put_disk(priv->gendisk);
548 dev_notice(&dev->sbd.core, "Synchronizing disk cache\n");
549 ps3disk_sync_cache(dev);
550 ps3stor_teardown(dev);
551 kfree(dev->bounce_buf);
552 kfree(priv);
553 dev->sbd.core.driver_data = NULL;
554 return 0;
555}
556
557static struct ps3_system_bus_driver ps3disk = {
558 .match_id = PS3_MATCH_ID_STOR_DISK,
559 .core.name = DEVICE_NAME,
560 .core.owner = THIS_MODULE,
561 .probe = ps3disk_probe,
562 .remove = ps3disk_remove,
563 .shutdown = ps3disk_remove,
564};
565
566
567static int __init ps3disk_init(void)
568{
569 int error;
570
571 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
572 return -ENODEV;
573
574 error = register_blkdev(0, DEVICE_NAME);
575 if (error <= 0) {
576 printk(KERN_ERR "%s:%u: register_blkdev failed %d\n", __func__,
577 __LINE__, error);
578 return error;
579 }
580 ps3disk_major = error;
581
582 pr_info("%s:%u: registered block device major %d\n", __func__,
583 __LINE__, ps3disk_major);
584
585 error = ps3_system_bus_driver_register(&ps3disk);
586 if (error)
587 unregister_blkdev(ps3disk_major, DEVICE_NAME);
588
589 return error;
590}
591
592static void __exit ps3disk_exit(void)
593{
594 ps3_system_bus_driver_unregister(&ps3disk);
595 unregister_blkdev(ps3disk_major, DEVICE_NAME);
596}
597
598module_init(ps3disk_init);
599module_exit(ps3disk_exit);
600
601MODULE_LICENSE("GPL");
602MODULE_DESCRIPTION("PS3 Disk Storage Driver");
603MODULE_AUTHOR("Sony Corporation");
604MODULE_ALIAS(PS3_MODULE_ALIAS_STOR_DISK);