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