GNU Linux-libre 4.4.288-gnu1
[releases.git] / drivers / block / rsxx / core.c
1 /*
2 * Filename: core.c
3 *
4 *
5 * Authors: Joshua Morris <josh.h.morris@us.ibm.com>
6 *       Philip Kelleher <pjk1939@linux.vnet.ibm.com>
7 *
8 * (C) Copyright 2013 IBM Corporation
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 */
24
25 #include <linux/kernel.h>
26 #include <linux/init.h>
27 #include <linux/interrupt.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/reboot.h>
31 #include <linux/slab.h>
32 #include <linux/bitops.h>
33 #include <linux/delay.h>
34 #include <linux/debugfs.h>
35 #include <linux/seq_file.h>
36
37 #include <linux/genhd.h>
38 #include <linux/idr.h>
39
40 #include "rsxx_priv.h"
41 #include "rsxx_cfg.h"
42
43 #define NO_LEGACY 0
44 #define SYNC_START_TIMEOUT (10 * 60) /* 10 minutes */
45
46 MODULE_DESCRIPTION("IBM Flash Adapter 900GB Full Height Device Driver");
47 MODULE_AUTHOR("Joshua Morris/Philip Kelleher, IBM");
48 MODULE_LICENSE("GPL");
49 MODULE_VERSION(DRIVER_VERSION);
50
51 static unsigned int force_legacy = NO_LEGACY;
52 module_param(force_legacy, uint, 0444);
53 MODULE_PARM_DESC(force_legacy, "Force the use of legacy type PCI interrupts");
54
55 static unsigned int sync_start = 1;
56 module_param(sync_start, uint, 0444);
57 MODULE_PARM_DESC(sync_start, "On by Default: Driver load will not complete "
58                              "until the card startup has completed.");
59
60 static DEFINE_IDA(rsxx_disk_ida);
61 static DEFINE_SPINLOCK(rsxx_ida_lock);
62
63 /* --------------------Debugfs Setup ------------------- */
64
65 static int rsxx_attr_pci_regs_show(struct seq_file *m, void *p)
66 {
67         struct rsxx_cardinfo *card = m->private;
68
69         seq_printf(m, "HWID             0x%08x\n",
70                                         ioread32(card->regmap + HWID));
71         seq_printf(m, "SCRATCH          0x%08x\n",
72                                         ioread32(card->regmap + SCRATCH));
73         seq_printf(m, "IER              0x%08x\n",
74                                         ioread32(card->regmap + IER));
75         seq_printf(m, "IPR              0x%08x\n",
76                                         ioread32(card->regmap + IPR));
77         seq_printf(m, "CREG_CMD         0x%08x\n",
78                                         ioread32(card->regmap + CREG_CMD));
79         seq_printf(m, "CREG_ADD         0x%08x\n",
80                                         ioread32(card->regmap + CREG_ADD));
81         seq_printf(m, "CREG_CNT         0x%08x\n",
82                                         ioread32(card->regmap + CREG_CNT));
83         seq_printf(m, "CREG_STAT        0x%08x\n",
84                                         ioread32(card->regmap + CREG_STAT));
85         seq_printf(m, "CREG_DATA0       0x%08x\n",
86                                         ioread32(card->regmap + CREG_DATA0));
87         seq_printf(m, "CREG_DATA1       0x%08x\n",
88                                         ioread32(card->regmap + CREG_DATA1));
89         seq_printf(m, "CREG_DATA2       0x%08x\n",
90                                         ioread32(card->regmap + CREG_DATA2));
91         seq_printf(m, "CREG_DATA3       0x%08x\n",
92                                         ioread32(card->regmap + CREG_DATA3));
93         seq_printf(m, "CREG_DATA4       0x%08x\n",
94                                         ioread32(card->regmap + CREG_DATA4));
95         seq_printf(m, "CREG_DATA5       0x%08x\n",
96                                         ioread32(card->regmap + CREG_DATA5));
97         seq_printf(m, "CREG_DATA6       0x%08x\n",
98                                         ioread32(card->regmap + CREG_DATA6));
99         seq_printf(m, "CREG_DATA7       0x%08x\n",
100                                         ioread32(card->regmap + CREG_DATA7));
101         seq_printf(m, "INTR_COAL        0x%08x\n",
102                                         ioread32(card->regmap + INTR_COAL));
103         seq_printf(m, "HW_ERROR         0x%08x\n",
104                                         ioread32(card->regmap + HW_ERROR));
105         seq_printf(m, "DEBUG0           0x%08x\n",
106                                         ioread32(card->regmap + PCI_DEBUG0));
107         seq_printf(m, "DEBUG1           0x%08x\n",
108                                         ioread32(card->regmap + PCI_DEBUG1));
109         seq_printf(m, "DEBUG2           0x%08x\n",
110                                         ioread32(card->regmap + PCI_DEBUG2));
111         seq_printf(m, "DEBUG3           0x%08x\n",
112                                         ioread32(card->regmap + PCI_DEBUG3));
113         seq_printf(m, "DEBUG4           0x%08x\n",
114                                         ioread32(card->regmap + PCI_DEBUG4));
115         seq_printf(m, "DEBUG5           0x%08x\n",
116                                         ioread32(card->regmap + PCI_DEBUG5));
117         seq_printf(m, "DEBUG6           0x%08x\n",
118                                         ioread32(card->regmap + PCI_DEBUG6));
119         seq_printf(m, "DEBUG7           0x%08x\n",
120                                         ioread32(card->regmap + PCI_DEBUG7));
121         seq_printf(m, "RECONFIG         0x%08x\n",
122                                         ioread32(card->regmap + PCI_RECONFIG));
123
124         return 0;
125 }
126
127 static int rsxx_attr_stats_show(struct seq_file *m, void *p)
128 {
129         struct rsxx_cardinfo *card = m->private;
130         int i;
131
132         for (i = 0; i < card->n_targets; i++) {
133                 seq_printf(m, "Ctrl %d CRC Errors       = %d\n",
134                                 i, card->ctrl[i].stats.crc_errors);
135                 seq_printf(m, "Ctrl %d Hard Errors      = %d\n",
136                                 i, card->ctrl[i].stats.hard_errors);
137                 seq_printf(m, "Ctrl %d Soft Errors      = %d\n",
138                                 i, card->ctrl[i].stats.soft_errors);
139                 seq_printf(m, "Ctrl %d Writes Issued    = %d\n",
140                                 i, card->ctrl[i].stats.writes_issued);
141                 seq_printf(m, "Ctrl %d Writes Failed    = %d\n",
142                                 i, card->ctrl[i].stats.writes_failed);
143                 seq_printf(m, "Ctrl %d Reads Issued     = %d\n",
144                                 i, card->ctrl[i].stats.reads_issued);
145                 seq_printf(m, "Ctrl %d Reads Failed     = %d\n",
146                                 i, card->ctrl[i].stats.reads_failed);
147                 seq_printf(m, "Ctrl %d Reads Retried    = %d\n",
148                                 i, card->ctrl[i].stats.reads_retried);
149                 seq_printf(m, "Ctrl %d Discards Issued  = %d\n",
150                                 i, card->ctrl[i].stats.discards_issued);
151                 seq_printf(m, "Ctrl %d Discards Failed  = %d\n",
152                                 i, card->ctrl[i].stats.discards_failed);
153                 seq_printf(m, "Ctrl %d DMA SW Errors    = %d\n",
154                                 i, card->ctrl[i].stats.dma_sw_err);
155                 seq_printf(m, "Ctrl %d DMA HW Faults    = %d\n",
156                                 i, card->ctrl[i].stats.dma_hw_fault);
157                 seq_printf(m, "Ctrl %d DMAs Cancelled   = %d\n",
158                                 i, card->ctrl[i].stats.dma_cancelled);
159                 seq_printf(m, "Ctrl %d SW Queue Depth   = %d\n",
160                                 i, card->ctrl[i].stats.sw_q_depth);
161                 seq_printf(m, "Ctrl %d HW Queue Depth   = %d\n",
162                         i, atomic_read(&card->ctrl[i].stats.hw_q_depth));
163         }
164
165         return 0;
166 }
167
168 static int rsxx_attr_stats_open(struct inode *inode, struct file *file)
169 {
170         return single_open(file, rsxx_attr_stats_show, inode->i_private);
171 }
172
173 static int rsxx_attr_pci_regs_open(struct inode *inode, struct file *file)
174 {
175         return single_open(file, rsxx_attr_pci_regs_show, inode->i_private);
176 }
177
178 static ssize_t rsxx_cram_read(struct file *fp, char __user *ubuf,
179                               size_t cnt, loff_t *ppos)
180 {
181         struct rsxx_cardinfo *card = file_inode(fp)->i_private;
182         char *buf;
183         int st;
184
185         buf = kzalloc(cnt, GFP_KERNEL);
186         if (!buf)
187                 return -ENOMEM;
188
189         st = rsxx_creg_read(card, CREG_ADD_CRAM + (u32)*ppos, cnt, buf, 1);
190         if (!st) {
191                 if (copy_to_user(ubuf, buf, cnt))
192                         st = -EFAULT;
193         }
194         kfree(buf);
195         if (st)
196                 return st;
197         *ppos += cnt;
198         return cnt;
199 }
200
201 static ssize_t rsxx_cram_write(struct file *fp, const char __user *ubuf,
202                                size_t cnt, loff_t *ppos)
203 {
204         struct rsxx_cardinfo *card = file_inode(fp)->i_private;
205         char *buf;
206         ssize_t st;
207
208         buf = kzalloc(cnt, GFP_KERNEL);
209         if (!buf)
210                 return -ENOMEM;
211
212         st = copy_from_user(buf, ubuf, cnt);
213         if (!st)
214                 st = rsxx_creg_write(card, CREG_ADD_CRAM + (u32)*ppos, cnt,
215                                      buf, 1);
216         kfree(buf);
217         if (st)
218                 return st;
219         *ppos += cnt;
220         return cnt;
221 }
222
223 static const struct file_operations debugfs_cram_fops = {
224         .owner          = THIS_MODULE,
225         .read           = rsxx_cram_read,
226         .write          = rsxx_cram_write,
227 };
228
229 static const struct file_operations debugfs_stats_fops = {
230         .owner          = THIS_MODULE,
231         .open           = rsxx_attr_stats_open,
232         .read           = seq_read,
233         .llseek         = seq_lseek,
234         .release        = single_release,
235 };
236
237 static const struct file_operations debugfs_pci_regs_fops = {
238         .owner          = THIS_MODULE,
239         .open           = rsxx_attr_pci_regs_open,
240         .read           = seq_read,
241         .llseek         = seq_lseek,
242         .release        = single_release,
243 };
244
245 static void rsxx_debugfs_dev_new(struct rsxx_cardinfo *card)
246 {
247         struct dentry *debugfs_stats;
248         struct dentry *debugfs_pci_regs;
249         struct dentry *debugfs_cram;
250
251         card->debugfs_dir = debugfs_create_dir(card->gendisk->disk_name, NULL);
252         if (IS_ERR_OR_NULL(card->debugfs_dir))
253                 goto failed_debugfs_dir;
254
255         debugfs_stats = debugfs_create_file("stats", S_IRUGO,
256                                             card->debugfs_dir, card,
257                                             &debugfs_stats_fops);
258         if (IS_ERR_OR_NULL(debugfs_stats))
259                 goto failed_debugfs_stats;
260
261         debugfs_pci_regs = debugfs_create_file("pci_regs", S_IRUGO,
262                                                card->debugfs_dir, card,
263                                                &debugfs_pci_regs_fops);
264         if (IS_ERR_OR_NULL(debugfs_pci_regs))
265                 goto failed_debugfs_pci_regs;
266
267         debugfs_cram = debugfs_create_file("cram", S_IRUGO | S_IWUSR,
268                                            card->debugfs_dir, card,
269                                            &debugfs_cram_fops);
270         if (IS_ERR_OR_NULL(debugfs_cram))
271                 goto failed_debugfs_cram;
272
273         return;
274 failed_debugfs_cram:
275         debugfs_remove(debugfs_pci_regs);
276 failed_debugfs_pci_regs:
277         debugfs_remove(debugfs_stats);
278 failed_debugfs_stats:
279         debugfs_remove(card->debugfs_dir);
280 failed_debugfs_dir:
281         card->debugfs_dir = NULL;
282 }
283
284 /*----------------- Interrupt Control & Handling -------------------*/
285
286 static void rsxx_mask_interrupts(struct rsxx_cardinfo *card)
287 {
288         card->isr_mask = 0;
289         card->ier_mask = 0;
290 }
291
292 static void __enable_intr(unsigned int *mask, unsigned int intr)
293 {
294         *mask |= intr;
295 }
296
297 static void __disable_intr(unsigned int *mask, unsigned int intr)
298 {
299         *mask &= ~intr;
300 }
301
302 /*
303  * NOTE: Disabling the IER will disable the hardware interrupt.
304  * Disabling the ISR will disable the software handling of the ISR bit.
305  *
306  * Enable/Disable interrupt functions assume the card->irq_lock
307  * is held by the caller.
308  */
309 void rsxx_enable_ier(struct rsxx_cardinfo *card, unsigned int intr)
310 {
311         if (unlikely(card->halt) ||
312             unlikely(card->eeh_state))
313                 return;
314
315         __enable_intr(&card->ier_mask, intr);
316         iowrite32(card->ier_mask, card->regmap + IER);
317 }
318
319 void rsxx_disable_ier(struct rsxx_cardinfo *card, unsigned int intr)
320 {
321         if (unlikely(card->eeh_state))
322                 return;
323
324         __disable_intr(&card->ier_mask, intr);
325         iowrite32(card->ier_mask, card->regmap + IER);
326 }
327
328 void rsxx_enable_ier_and_isr(struct rsxx_cardinfo *card,
329                                  unsigned int intr)
330 {
331         if (unlikely(card->halt) ||
332             unlikely(card->eeh_state))
333                 return;
334
335         __enable_intr(&card->isr_mask, intr);
336         __enable_intr(&card->ier_mask, intr);
337         iowrite32(card->ier_mask, card->regmap + IER);
338 }
339 void rsxx_disable_ier_and_isr(struct rsxx_cardinfo *card,
340                                   unsigned int intr)
341 {
342         if (unlikely(card->eeh_state))
343                 return;
344
345         __disable_intr(&card->isr_mask, intr);
346         __disable_intr(&card->ier_mask, intr);
347         iowrite32(card->ier_mask, card->regmap + IER);
348 }
349
350 static irqreturn_t rsxx_isr(int irq, void *pdata)
351 {
352         struct rsxx_cardinfo *card = pdata;
353         unsigned int isr;
354         int handled = 0;
355         int reread_isr;
356         int i;
357
358         spin_lock(&card->irq_lock);
359
360         do {
361                 reread_isr = 0;
362
363                 if (unlikely(card->eeh_state))
364                         break;
365
366                 isr = ioread32(card->regmap + ISR);
367                 if (isr == 0xffffffff) {
368                         /*
369                          * A few systems seem to have an intermittent issue
370                          * where PCI reads return all Fs, but retrying the read
371                          * a little later will return as expected.
372                          */
373                         dev_info(CARD_TO_DEV(card),
374                                 "ISR = 0xFFFFFFFF, retrying later\n");
375                         break;
376                 }
377
378                 isr &= card->isr_mask;
379                 if (!isr)
380                         break;
381
382                 for (i = 0; i < card->n_targets; i++) {
383                         if (isr & CR_INTR_DMA(i)) {
384                                 if (card->ier_mask & CR_INTR_DMA(i)) {
385                                         rsxx_disable_ier(card, CR_INTR_DMA(i));
386                                         reread_isr = 1;
387                                 }
388                                 queue_work(card->ctrl[i].done_wq,
389                                            &card->ctrl[i].dma_done_work);
390                                 handled++;
391                         }
392                 }
393
394                 if (isr & CR_INTR_CREG) {
395                         queue_work(card->creg_ctrl.creg_wq,
396                                    &card->creg_ctrl.done_work);
397                         handled++;
398                 }
399
400                 if (isr & CR_INTR_EVENT) {
401                         queue_work(card->event_wq, &card->event_work);
402                         rsxx_disable_ier_and_isr(card, CR_INTR_EVENT);
403                         handled++;
404                 }
405         } while (reread_isr);
406
407         spin_unlock(&card->irq_lock);
408
409         return handled ? IRQ_HANDLED : IRQ_NONE;
410 }
411
412 /*----------------- Card Event Handler -------------------*/
413 static const char * const rsxx_card_state_to_str(unsigned int state)
414 {
415         static const char * const state_strings[] = {
416                 "Unknown", "Shutdown", "Starting", "Formatting",
417                 "Uninitialized", "Good", "Shutting Down",
418                 "Fault", "Read Only Fault", "dStroying"
419         };
420
421         return state_strings[ffs(state)];
422 }
423
424 static void card_state_change(struct rsxx_cardinfo *card,
425                               unsigned int new_state)
426 {
427         int st;
428
429         dev_info(CARD_TO_DEV(card),
430                 "card state change detected.(%s -> %s)\n",
431                 rsxx_card_state_to_str(card->state),
432                 rsxx_card_state_to_str(new_state));
433
434         card->state = new_state;
435
436         /* Don't attach DMA interfaces if the card has an invalid config */
437         if (!card->config_valid)
438                 return;
439
440         switch (new_state) {
441         case CARD_STATE_RD_ONLY_FAULT:
442                 dev_crit(CARD_TO_DEV(card),
443                         "Hardware has entered read-only mode!\n");
444                 /*
445                  * Fall through so the DMA devices can be attached and
446                  * the user can attempt to pull off their data.
447                  */
448         case CARD_STATE_GOOD:
449                 st = rsxx_get_card_size8(card, &card->size8);
450                 if (st)
451                         dev_err(CARD_TO_DEV(card),
452                                 "Failed attaching DMA devices\n");
453
454                 if (card->config_valid)
455                         set_capacity(card->gendisk, card->size8 >> 9);
456                 break;
457
458         case CARD_STATE_FAULT:
459                 dev_crit(CARD_TO_DEV(card),
460                         "Hardware Fault reported!\n");
461                 /* Fall through. */
462
463         /* Everything else, detach DMA interface if it's attached. */
464         case CARD_STATE_SHUTDOWN:
465         case CARD_STATE_STARTING:
466         case CARD_STATE_FORMATTING:
467         case CARD_STATE_UNINITIALIZED:
468         case CARD_STATE_SHUTTING_DOWN:
469         /*
470          * dStroy is a term coined by marketing to represent the low level
471          * secure erase.
472          */
473         case CARD_STATE_DSTROYING:
474                 set_capacity(card->gendisk, 0);
475                 break;
476         }
477 }
478
479 static void card_event_handler(struct work_struct *work)
480 {
481         struct rsxx_cardinfo *card;
482         unsigned int state;
483         unsigned long flags;
484         int st;
485
486         card = container_of(work, struct rsxx_cardinfo, event_work);
487
488         if (unlikely(card->halt))
489                 return;
490
491         /*
492          * Enable the interrupt now to avoid any weird race conditions where a
493          * state change might occur while rsxx_get_card_state() is
494          * processing a returned creg cmd.
495          */
496         spin_lock_irqsave(&card->irq_lock, flags);
497         rsxx_enable_ier_and_isr(card, CR_INTR_EVENT);
498         spin_unlock_irqrestore(&card->irq_lock, flags);
499
500         st = rsxx_get_card_state(card, &state);
501         if (st) {
502                 dev_info(CARD_TO_DEV(card),
503                         "Failed reading state after event.\n");
504                 return;
505         }
506
507         if (card->state != state)
508                 card_state_change(card, state);
509
510         if (card->creg_ctrl.creg_stats.stat & CREG_STAT_LOG_PENDING)
511                 rsxx_read_hw_log(card);
512 }
513
514 /*----------------- Card Operations -------------------*/
515 static int card_shutdown(struct rsxx_cardinfo *card)
516 {
517         unsigned int state;
518         signed long start;
519         const int timeout = msecs_to_jiffies(120000);
520         int st;
521
522         /* We can't issue a shutdown if the card is in a transition state */
523         start = jiffies;
524         do {
525                 st = rsxx_get_card_state(card, &state);
526                 if (st)
527                         return st;
528         } while (state == CARD_STATE_STARTING &&
529                  (jiffies - start < timeout));
530
531         if (state == CARD_STATE_STARTING)
532                 return -ETIMEDOUT;
533
534         /* Only issue a shutdown if we need to */
535         if ((state != CARD_STATE_SHUTTING_DOWN) &&
536             (state != CARD_STATE_SHUTDOWN)) {
537                 st = rsxx_issue_card_cmd(card, CARD_CMD_SHUTDOWN);
538                 if (st)
539                         return st;
540         }
541
542         start = jiffies;
543         do {
544                 st = rsxx_get_card_state(card, &state);
545                 if (st)
546                         return st;
547         } while (state != CARD_STATE_SHUTDOWN &&
548                  (jiffies - start < timeout));
549
550         if (state != CARD_STATE_SHUTDOWN)
551                 return -ETIMEDOUT;
552
553         return 0;
554 }
555
556 static int rsxx_eeh_frozen(struct pci_dev *dev)
557 {
558         struct rsxx_cardinfo *card = pci_get_drvdata(dev);
559         int i;
560         int st;
561
562         dev_warn(&dev->dev, "IBM Flash Adapter PCI: preparing for slot reset.\n");
563
564         card->eeh_state = 1;
565         rsxx_mask_interrupts(card);
566
567         /*
568          * We need to guarantee that the write for eeh_state and masking
569          * interrupts does not become reordered. This will prevent a possible
570          * race condition with the EEH code.
571          */
572         wmb();
573
574         pci_disable_device(dev);
575
576         st = rsxx_eeh_save_issued_dmas(card);
577         if (st)
578                 return st;
579
580         rsxx_eeh_save_issued_creg(card);
581
582         for (i = 0; i < card->n_targets; i++) {
583                 if (card->ctrl[i].status.buf)
584                         pci_free_consistent(card->dev, STATUS_BUFFER_SIZE8,
585                                             card->ctrl[i].status.buf,
586                                             card->ctrl[i].status.dma_addr);
587                 if (card->ctrl[i].cmd.buf)
588                         pci_free_consistent(card->dev, COMMAND_BUFFER_SIZE8,
589                                             card->ctrl[i].cmd.buf,
590                                             card->ctrl[i].cmd.dma_addr);
591         }
592
593         return 0;
594 }
595
596 static void rsxx_eeh_failure(struct pci_dev *dev)
597 {
598         struct rsxx_cardinfo *card = pci_get_drvdata(dev);
599         int i;
600         int cnt = 0;
601
602         dev_err(&dev->dev, "IBM Flash Adapter PCI: disabling failed card.\n");
603
604         card->eeh_state = 1;
605         card->halt = 1;
606
607         for (i = 0; i < card->n_targets; i++) {
608                 spin_lock_bh(&card->ctrl[i].queue_lock);
609                 cnt = rsxx_cleanup_dma_queue(&card->ctrl[i],
610                                              &card->ctrl[i].queue,
611                                              COMPLETE_DMA);
612                 spin_unlock_bh(&card->ctrl[i].queue_lock);
613
614                 cnt += rsxx_dma_cancel(&card->ctrl[i]);
615
616                 if (cnt)
617                         dev_info(CARD_TO_DEV(card),
618                                 "Freed %d queued DMAs on channel %d\n",
619                                 cnt, card->ctrl[i].id);
620         }
621 }
622
623 static int rsxx_eeh_fifo_flush_poll(struct rsxx_cardinfo *card)
624 {
625         unsigned int status;
626         int iter = 0;
627
628         /* We need to wait for the hardware to reset */
629         while (iter++ < 10) {
630                 status = ioread32(card->regmap + PCI_RECONFIG);
631
632                 if (status & RSXX_FLUSH_BUSY) {
633                         ssleep(1);
634                         continue;
635                 }
636
637                 if (status & RSXX_FLUSH_TIMEOUT)
638                         dev_warn(CARD_TO_DEV(card), "HW: flash controller timeout\n");
639                 return 0;
640         }
641
642         /* Hardware failed resetting itself. */
643         return -1;
644 }
645
646 static pci_ers_result_t rsxx_error_detected(struct pci_dev *dev,
647                                             enum pci_channel_state error)
648 {
649         int st;
650
651         if (dev->revision < RSXX_EEH_SUPPORT)
652                 return PCI_ERS_RESULT_NONE;
653
654         if (error == pci_channel_io_perm_failure) {
655                 rsxx_eeh_failure(dev);
656                 return PCI_ERS_RESULT_DISCONNECT;
657         }
658
659         st = rsxx_eeh_frozen(dev);
660         if (st) {
661                 dev_err(&dev->dev, "Slot reset setup failed\n");
662                 rsxx_eeh_failure(dev);
663                 return PCI_ERS_RESULT_DISCONNECT;
664         }
665
666         return PCI_ERS_RESULT_NEED_RESET;
667 }
668
669 static pci_ers_result_t rsxx_slot_reset(struct pci_dev *dev)
670 {
671         struct rsxx_cardinfo *card = pci_get_drvdata(dev);
672         unsigned long flags;
673         int i;
674         int st;
675
676         dev_warn(&dev->dev,
677                 "IBM Flash Adapter PCI: recovering from slot reset.\n");
678
679         st = pci_enable_device(dev);
680         if (st)
681                 goto failed_hw_setup;
682
683         pci_set_master(dev);
684
685         st = rsxx_eeh_fifo_flush_poll(card);
686         if (st)
687                 goto failed_hw_setup;
688
689         rsxx_dma_queue_reset(card);
690
691         for (i = 0; i < card->n_targets; i++) {
692                 st = rsxx_hw_buffers_init(dev, &card->ctrl[i]);
693                 if (st)
694                         goto failed_hw_buffers_init;
695         }
696
697         if (card->config_valid)
698                 rsxx_dma_configure(card);
699
700         /* Clears the ISR register from spurious interrupts */
701         st = ioread32(card->regmap + ISR);
702
703         card->eeh_state = 0;
704
705         spin_lock_irqsave(&card->irq_lock, flags);
706         if (card->n_targets & RSXX_MAX_TARGETS)
707                 rsxx_enable_ier_and_isr(card, CR_INTR_ALL_G);
708         else
709                 rsxx_enable_ier_and_isr(card, CR_INTR_ALL_C);
710         spin_unlock_irqrestore(&card->irq_lock, flags);
711
712         rsxx_kick_creg_queue(card);
713
714         for (i = 0; i < card->n_targets; i++) {
715                 spin_lock(&card->ctrl[i].queue_lock);
716                 if (list_empty(&card->ctrl[i].queue)) {
717                         spin_unlock(&card->ctrl[i].queue_lock);
718                         continue;
719                 }
720                 spin_unlock(&card->ctrl[i].queue_lock);
721
722                 queue_work(card->ctrl[i].issue_wq,
723                                 &card->ctrl[i].issue_dma_work);
724         }
725
726         dev_info(&dev->dev, "IBM Flash Adapter PCI: recovery complete.\n");
727
728         return PCI_ERS_RESULT_RECOVERED;
729
730 failed_hw_buffers_init:
731         for (i = 0; i < card->n_targets; i++) {
732                 if (card->ctrl[i].status.buf)
733                         pci_free_consistent(card->dev,
734                                         STATUS_BUFFER_SIZE8,
735                                         card->ctrl[i].status.buf,
736                                         card->ctrl[i].status.dma_addr);
737                 if (card->ctrl[i].cmd.buf)
738                         pci_free_consistent(card->dev,
739                                         COMMAND_BUFFER_SIZE8,
740                                         card->ctrl[i].cmd.buf,
741                                         card->ctrl[i].cmd.dma_addr);
742         }
743 failed_hw_setup:
744         rsxx_eeh_failure(dev);
745         return PCI_ERS_RESULT_DISCONNECT;
746
747 }
748
749 /*----------------- Driver Initialization & Setup -------------------*/
750 /* Returns:   0 if the driver is compatible with the device
751              -1 if the driver is NOT compatible with the device */
752 static int rsxx_compatibility_check(struct rsxx_cardinfo *card)
753 {
754         unsigned char pci_rev;
755
756         pci_read_config_byte(card->dev, PCI_REVISION_ID, &pci_rev);
757
758         if (pci_rev > RS70_PCI_REV_SUPPORTED)
759                 return -1;
760         return 0;
761 }
762
763 static int rsxx_pci_probe(struct pci_dev *dev,
764                                         const struct pci_device_id *id)
765 {
766         struct rsxx_cardinfo *card;
767         int st;
768         unsigned int sync_timeout;
769
770         dev_info(&dev->dev, "PCI-Flash SSD discovered\n");
771
772         card = kzalloc(sizeof(*card), GFP_KERNEL);
773         if (!card)
774                 return -ENOMEM;
775
776         card->dev = dev;
777         pci_set_drvdata(dev, card);
778
779         do {
780                 if (!ida_pre_get(&rsxx_disk_ida, GFP_KERNEL)) {
781                         st = -ENOMEM;
782                         goto failed_ida_get;
783                 }
784
785                 spin_lock(&rsxx_ida_lock);
786                 st = ida_get_new(&rsxx_disk_ida, &card->disk_id);
787                 spin_unlock(&rsxx_ida_lock);
788         } while (st == -EAGAIN);
789
790         if (st)
791                 goto failed_ida_get;
792
793         st = pci_enable_device(dev);
794         if (st)
795                 goto failed_enable;
796
797         pci_set_master(dev);
798         pci_set_dma_max_seg_size(dev, RSXX_HW_BLK_SIZE);
799
800         st = pci_set_dma_mask(dev, DMA_BIT_MASK(64));
801         if (st) {
802                 dev_err(CARD_TO_DEV(card),
803                         "No usable DMA configuration,aborting\n");
804                 goto failed_dma_mask;
805         }
806
807         st = pci_request_regions(dev, DRIVER_NAME);
808         if (st) {
809                 dev_err(CARD_TO_DEV(card),
810                         "Failed to request memory region\n");
811                 goto failed_request_regions;
812         }
813
814         if (pci_resource_len(dev, 0) == 0) {
815                 dev_err(CARD_TO_DEV(card), "BAR0 has length 0!\n");
816                 st = -ENOMEM;
817                 goto failed_iomap;
818         }
819
820         card->regmap = pci_iomap(dev, 0, 0);
821         if (!card->regmap) {
822                 dev_err(CARD_TO_DEV(card), "Failed to map BAR0\n");
823                 st = -ENOMEM;
824                 goto failed_iomap;
825         }
826
827         spin_lock_init(&card->irq_lock);
828         card->halt = 0;
829         card->eeh_state = 0;
830
831         spin_lock_irq(&card->irq_lock);
832         rsxx_disable_ier_and_isr(card, CR_INTR_ALL);
833         spin_unlock_irq(&card->irq_lock);
834
835         if (!force_legacy) {
836                 st = pci_enable_msi(dev);
837                 if (st)
838                         dev_warn(CARD_TO_DEV(card),
839                                 "Failed to enable MSI\n");
840         }
841
842         st = request_irq(dev->irq, rsxx_isr, IRQF_SHARED,
843                          DRIVER_NAME, card);
844         if (st) {
845                 dev_err(CARD_TO_DEV(card),
846                         "Failed requesting IRQ%d\n", dev->irq);
847                 goto failed_irq;
848         }
849
850         /************* Setup Processor Command Interface *************/
851         st = rsxx_creg_setup(card);
852         if (st) {
853                 dev_err(CARD_TO_DEV(card), "Failed to setup creg interface.\n");
854                 goto failed_creg_setup;
855         }
856
857         spin_lock_irq(&card->irq_lock);
858         rsxx_enable_ier_and_isr(card, CR_INTR_CREG);
859         spin_unlock_irq(&card->irq_lock);
860
861         st = rsxx_compatibility_check(card);
862         if (st) {
863                 dev_warn(CARD_TO_DEV(card),
864                         "Incompatible driver detected. Please update the driver.\n");
865                 st = -EINVAL;
866                 goto failed_compatiblity_check;
867         }
868
869         /************* Load Card Config *************/
870         st = rsxx_load_config(card);
871         if (st)
872                 dev_err(CARD_TO_DEV(card),
873                         "Failed loading card config\n");
874
875         /************* Setup DMA Engine *************/
876         st = rsxx_get_num_targets(card, &card->n_targets);
877         if (st)
878                 dev_info(CARD_TO_DEV(card),
879                         "Failed reading the number of DMA targets\n");
880
881         card->ctrl = kzalloc(card->n_targets * sizeof(*card->ctrl), GFP_KERNEL);
882         if (!card->ctrl) {
883                 st = -ENOMEM;
884                 goto failed_dma_setup;
885         }
886
887         st = rsxx_dma_setup(card);
888         if (st) {
889                 dev_info(CARD_TO_DEV(card),
890                         "Failed to setup DMA engine\n");
891                 goto failed_dma_setup;
892         }
893
894         /************* Setup Card Event Handler *************/
895         card->event_wq = create_singlethread_workqueue(DRIVER_NAME"_event");
896         if (!card->event_wq) {
897                 dev_err(CARD_TO_DEV(card), "Failed card event setup.\n");
898                 st = -ENOMEM;
899                 goto failed_event_handler;
900         }
901
902         INIT_WORK(&card->event_work, card_event_handler);
903
904         st = rsxx_setup_dev(card);
905         if (st)
906                 goto failed_create_dev;
907
908         rsxx_get_card_state(card, &card->state);
909
910         dev_info(CARD_TO_DEV(card),
911                 "card state: %s\n",
912                 rsxx_card_state_to_str(card->state));
913
914         /*
915          * Now that the DMA Engine and devices have been setup,
916          * we can enable the event interrupt(it kicks off actions in
917          * those layers so we couldn't enable it right away.)
918          */
919         spin_lock_irq(&card->irq_lock);
920         rsxx_enable_ier_and_isr(card, CR_INTR_EVENT);
921         spin_unlock_irq(&card->irq_lock);
922
923         if (card->state == CARD_STATE_SHUTDOWN) {
924                 st = rsxx_issue_card_cmd(card, CARD_CMD_STARTUP);
925                 if (st)
926                         dev_crit(CARD_TO_DEV(card),
927                                 "Failed issuing card startup\n");
928                 if (sync_start) {
929                         sync_timeout = SYNC_START_TIMEOUT;
930
931                         dev_info(CARD_TO_DEV(card),
932                                  "Waiting for card to startup\n");
933
934                         do {
935                                 ssleep(1);
936                                 sync_timeout--;
937
938                                 rsxx_get_card_state(card, &card->state);
939                         } while (sync_timeout &&
940                                 (card->state == CARD_STATE_STARTING));
941
942                         if (card->state == CARD_STATE_STARTING) {
943                                 dev_warn(CARD_TO_DEV(card),
944                                          "Card startup timed out\n");
945                                 card->size8 = 0;
946                         } else {
947                                 dev_info(CARD_TO_DEV(card),
948                                         "card state: %s\n",
949                                         rsxx_card_state_to_str(card->state));
950                                 st = rsxx_get_card_size8(card, &card->size8);
951                                 if (st)
952                                         card->size8 = 0;
953                         }
954                 }
955         } else if (card->state == CARD_STATE_GOOD ||
956                    card->state == CARD_STATE_RD_ONLY_FAULT) {
957                 st = rsxx_get_card_size8(card, &card->size8);
958                 if (st)
959                         card->size8 = 0;
960         }
961
962         rsxx_attach_dev(card);
963
964         /************* Setup Debugfs *************/
965         rsxx_debugfs_dev_new(card);
966
967         return 0;
968
969 failed_create_dev:
970         destroy_workqueue(card->event_wq);
971         card->event_wq = NULL;
972 failed_event_handler:
973         rsxx_dma_destroy(card);
974 failed_dma_setup:
975 failed_compatiblity_check:
976         destroy_workqueue(card->creg_ctrl.creg_wq);
977         card->creg_ctrl.creg_wq = NULL;
978 failed_creg_setup:
979         spin_lock_irq(&card->irq_lock);
980         rsxx_disable_ier_and_isr(card, CR_INTR_ALL);
981         spin_unlock_irq(&card->irq_lock);
982         free_irq(dev->irq, card);
983         if (!force_legacy)
984                 pci_disable_msi(dev);
985 failed_irq:
986         pci_iounmap(dev, card->regmap);
987 failed_iomap:
988         pci_release_regions(dev);
989 failed_request_regions:
990 failed_dma_mask:
991         pci_disable_device(dev);
992 failed_enable:
993         spin_lock(&rsxx_ida_lock);
994         ida_remove(&rsxx_disk_ida, card->disk_id);
995         spin_unlock(&rsxx_ida_lock);
996 failed_ida_get:
997         kfree(card);
998
999         return st;
1000 }
1001
1002 static void rsxx_pci_remove(struct pci_dev *dev)
1003 {
1004         struct rsxx_cardinfo *card = pci_get_drvdata(dev);
1005         unsigned long flags;
1006         int st;
1007         int i;
1008
1009         if (!card)
1010                 return;
1011
1012         dev_info(CARD_TO_DEV(card),
1013                 "Removing PCI-Flash SSD.\n");
1014
1015         rsxx_detach_dev(card);
1016
1017         for (i = 0; i < card->n_targets; i++) {
1018                 spin_lock_irqsave(&card->irq_lock, flags);
1019                 rsxx_disable_ier_and_isr(card, CR_INTR_DMA(i));
1020                 spin_unlock_irqrestore(&card->irq_lock, flags);
1021         }
1022
1023         st = card_shutdown(card);
1024         if (st)
1025                 dev_crit(CARD_TO_DEV(card), "Shutdown failed!\n");
1026
1027         /* Sync outstanding event handlers. */
1028         spin_lock_irqsave(&card->irq_lock, flags);
1029         rsxx_disable_ier_and_isr(card, CR_INTR_EVENT);
1030         spin_unlock_irqrestore(&card->irq_lock, flags);
1031
1032         cancel_work_sync(&card->event_work);
1033
1034         destroy_workqueue(card->event_wq);
1035         rsxx_destroy_dev(card);
1036         rsxx_dma_destroy(card);
1037         destroy_workqueue(card->creg_ctrl.creg_wq);
1038
1039         spin_lock_irqsave(&card->irq_lock, flags);
1040         rsxx_disable_ier_and_isr(card, CR_INTR_ALL);
1041         spin_unlock_irqrestore(&card->irq_lock, flags);
1042
1043         /* Prevent work_structs from re-queuing themselves. */
1044         card->halt = 1;
1045
1046         debugfs_remove_recursive(card->debugfs_dir);
1047
1048         free_irq(dev->irq, card);
1049
1050         if (!force_legacy)
1051                 pci_disable_msi(dev);
1052
1053         rsxx_creg_destroy(card);
1054
1055         pci_iounmap(dev, card->regmap);
1056
1057         pci_disable_device(dev);
1058         pci_release_regions(dev);
1059
1060         kfree(card);
1061 }
1062
1063 static int rsxx_pci_suspend(struct pci_dev *dev, pm_message_t state)
1064 {
1065         /* We don't support suspend at this time. */
1066         return -ENOSYS;
1067 }
1068
1069 static void rsxx_pci_shutdown(struct pci_dev *dev)
1070 {
1071         struct rsxx_cardinfo *card = pci_get_drvdata(dev);
1072         unsigned long flags;
1073         int i;
1074
1075         if (!card)
1076                 return;
1077
1078         dev_info(CARD_TO_DEV(card), "Shutting down PCI-Flash SSD.\n");
1079
1080         rsxx_detach_dev(card);
1081
1082         for (i = 0; i < card->n_targets; i++) {
1083                 spin_lock_irqsave(&card->irq_lock, flags);
1084                 rsxx_disable_ier_and_isr(card, CR_INTR_DMA(i));
1085                 spin_unlock_irqrestore(&card->irq_lock, flags);
1086         }
1087
1088         card_shutdown(card);
1089 }
1090
1091 static const struct pci_error_handlers rsxx_err_handler = {
1092         .error_detected = rsxx_error_detected,
1093         .slot_reset     = rsxx_slot_reset,
1094 };
1095
1096 static const struct pci_device_id rsxx_pci_ids[] = {
1097         {PCI_DEVICE(PCI_VENDOR_ID_IBM, PCI_DEVICE_ID_FS70_FLASH)},
1098         {PCI_DEVICE(PCI_VENDOR_ID_IBM, PCI_DEVICE_ID_FS80_FLASH)},
1099         {0,},
1100 };
1101
1102 MODULE_DEVICE_TABLE(pci, rsxx_pci_ids);
1103
1104 static struct pci_driver rsxx_pci_driver = {
1105         .name           = DRIVER_NAME,
1106         .id_table       = rsxx_pci_ids,
1107         .probe          = rsxx_pci_probe,
1108         .remove         = rsxx_pci_remove,
1109         .suspend        = rsxx_pci_suspend,
1110         .shutdown       = rsxx_pci_shutdown,
1111         .err_handler    = &rsxx_err_handler,
1112 };
1113
1114 static int __init rsxx_core_init(void)
1115 {
1116         int st;
1117
1118         st = rsxx_dev_init();
1119         if (st)
1120                 return st;
1121
1122         st = rsxx_dma_init();
1123         if (st)
1124                 goto dma_init_failed;
1125
1126         st = rsxx_creg_init();
1127         if (st)
1128                 goto creg_init_failed;
1129
1130         return pci_register_driver(&rsxx_pci_driver);
1131
1132 creg_init_failed:
1133         rsxx_dma_cleanup();
1134 dma_init_failed:
1135         rsxx_dev_cleanup();
1136
1137         return st;
1138 }
1139
1140 static void __exit rsxx_core_cleanup(void)
1141 {
1142         pci_unregister_driver(&rsxx_pci_driver);
1143         rsxx_creg_cleanup();
1144         rsxx_dma_cleanup();
1145         rsxx_dev_cleanup();
1146 }
1147
1148 module_init(rsxx_core_init);
1149 module_exit(rsxx_core_cleanup);