5 * Authors: Joshua Morris <josh.h.morris@us.ibm.com>
6 * Philip Kelleher <pjk1939@linux.vnet.ibm.com>
8 * (C) Copyright 2013 IBM Corporation
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.
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.
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
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>
35 #include <linux/genhd.h>
36 #include <linux/idr.h>
38 #include "rsxx_priv.h"
43 MODULE_DESCRIPTION("IBM FlashSystem 70/80 PCIe SSD Device Driver");
44 MODULE_AUTHOR("Joshua Morris/Philip Kelleher, IBM");
45 MODULE_LICENSE("GPL");
46 MODULE_VERSION(DRIVER_VERSION
);
48 static unsigned int force_legacy
= NO_LEGACY
;
49 module_param(force_legacy
, uint
, 0444);
50 MODULE_PARM_DESC(force_legacy
, "Force the use of legacy type PCI interrupts");
52 static DEFINE_IDA(rsxx_disk_ida
);
53 static DEFINE_SPINLOCK(rsxx_ida_lock
);
55 /*----------------- Interrupt Control & Handling -------------------*/
57 static void rsxx_mask_interrupts(struct rsxx_cardinfo
*card
)
63 static void __enable_intr(unsigned int *mask
, unsigned int intr
)
68 static void __disable_intr(unsigned int *mask
, unsigned int intr
)
74 * NOTE: Disabling the IER will disable the hardware interrupt.
75 * Disabling the ISR will disable the software handling of the ISR bit.
77 * Enable/Disable interrupt functions assume the card->irq_lock
78 * is held by the caller.
80 void rsxx_enable_ier(struct rsxx_cardinfo
*card
, unsigned int intr
)
82 if (unlikely(card
->halt
) ||
83 unlikely(card
->eeh_state
))
86 __enable_intr(&card
->ier_mask
, intr
);
87 iowrite32(card
->ier_mask
, card
->regmap
+ IER
);
90 void rsxx_disable_ier(struct rsxx_cardinfo
*card
, unsigned int intr
)
92 if (unlikely(card
->eeh_state
))
95 __disable_intr(&card
->ier_mask
, intr
);
96 iowrite32(card
->ier_mask
, card
->regmap
+ IER
);
99 void rsxx_enable_ier_and_isr(struct rsxx_cardinfo
*card
,
102 if (unlikely(card
->halt
) ||
103 unlikely(card
->eeh_state
))
106 __enable_intr(&card
->isr_mask
, intr
);
107 __enable_intr(&card
->ier_mask
, intr
);
108 iowrite32(card
->ier_mask
, card
->regmap
+ IER
);
110 void rsxx_disable_ier_and_isr(struct rsxx_cardinfo
*card
,
113 if (unlikely(card
->eeh_state
))
116 __disable_intr(&card
->isr_mask
, intr
);
117 __disable_intr(&card
->ier_mask
, intr
);
118 iowrite32(card
->ier_mask
, card
->regmap
+ IER
);
121 static irqreturn_t
rsxx_isr(int irq
, void *pdata
)
123 struct rsxx_cardinfo
*card
= pdata
;
129 spin_lock(&card
->irq_lock
);
134 if (unlikely(card
->eeh_state
))
137 isr
= ioread32(card
->regmap
+ ISR
);
138 if (isr
== 0xffffffff) {
140 * A few systems seem to have an intermittent issue
141 * where PCI reads return all Fs, but retrying the read
142 * a little later will return as expected.
144 dev_info(CARD_TO_DEV(card
),
145 "ISR = 0xFFFFFFFF, retrying later\n");
149 isr
&= card
->isr_mask
;
153 for (i
= 0; i
< card
->n_targets
; i
++) {
154 if (isr
& CR_INTR_DMA(i
)) {
155 if (card
->ier_mask
& CR_INTR_DMA(i
)) {
156 rsxx_disable_ier(card
, CR_INTR_DMA(i
));
159 queue_work(card
->ctrl
[i
].done_wq
,
160 &card
->ctrl
[i
].dma_done_work
);
165 if (isr
& CR_INTR_CREG
) {
166 schedule_work(&card
->creg_ctrl
.done_work
);
170 if (isr
& CR_INTR_EVENT
) {
171 schedule_work(&card
->event_work
);
172 rsxx_disable_ier_and_isr(card
, CR_INTR_EVENT
);
175 } while (reread_isr
);
177 spin_unlock(&card
->irq_lock
);
179 return handled
? IRQ_HANDLED
: IRQ_NONE
;
182 /*----------------- Card Event Handler -------------------*/
183 static const char * const rsxx_card_state_to_str(unsigned int state
)
185 static const char * const state_strings
[] = {
186 "Unknown", "Shutdown", "Starting", "Formatting",
187 "Uninitialized", "Good", "Shutting Down",
188 "Fault", "Read Only Fault", "dStroying"
191 return state_strings
[ffs(state
)];
194 static void card_state_change(struct rsxx_cardinfo
*card
,
195 unsigned int new_state
)
199 dev_info(CARD_TO_DEV(card
),
200 "card state change detected.(%s -> %s)\n",
201 rsxx_card_state_to_str(card
->state
),
202 rsxx_card_state_to_str(new_state
));
204 card
->state
= new_state
;
206 /* Don't attach DMA interfaces if the card has an invalid config */
207 if (!card
->config_valid
)
211 case CARD_STATE_RD_ONLY_FAULT
:
212 dev_crit(CARD_TO_DEV(card
),
213 "Hardware has entered read-only mode!\n");
215 * Fall through so the DMA devices can be attached and
216 * the user can attempt to pull off their data.
218 case CARD_STATE_GOOD
:
219 st
= rsxx_get_card_size8(card
, &card
->size8
);
221 dev_err(CARD_TO_DEV(card
),
222 "Failed attaching DMA devices\n");
224 if (card
->config_valid
)
225 set_capacity(card
->gendisk
, card
->size8
>> 9);
228 case CARD_STATE_FAULT
:
229 dev_crit(CARD_TO_DEV(card
),
230 "Hardware Fault reported!\n");
233 /* Everything else, detach DMA interface if it's attached. */
234 case CARD_STATE_SHUTDOWN
:
235 case CARD_STATE_STARTING
:
236 case CARD_STATE_FORMATTING
:
237 case CARD_STATE_UNINITIALIZED
:
238 case CARD_STATE_SHUTTING_DOWN
:
240 * dStroy is a term coined by marketing to represent the low level
243 case CARD_STATE_DSTROYING
:
244 set_capacity(card
->gendisk
, 0);
249 static void card_event_handler(struct work_struct
*work
)
251 struct rsxx_cardinfo
*card
;
256 card
= container_of(work
, struct rsxx_cardinfo
, event_work
);
258 if (unlikely(card
->halt
))
262 * Enable the interrupt now to avoid any weird race conditions where a
263 * state change might occur while rsxx_get_card_state() is
264 * processing a returned creg cmd.
266 spin_lock_irqsave(&card
->irq_lock
, flags
);
267 rsxx_enable_ier_and_isr(card
, CR_INTR_EVENT
);
268 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
270 st
= rsxx_get_card_state(card
, &state
);
272 dev_info(CARD_TO_DEV(card
),
273 "Failed reading state after event.\n");
277 if (card
->state
!= state
)
278 card_state_change(card
, state
);
280 if (card
->creg_ctrl
.creg_stats
.stat
& CREG_STAT_LOG_PENDING
)
281 rsxx_read_hw_log(card
);
284 /*----------------- Card Operations -------------------*/
285 static int card_shutdown(struct rsxx_cardinfo
*card
)
289 const int timeout
= msecs_to_jiffies(120000);
292 /* We can't issue a shutdown if the card is in a transition state */
295 st
= rsxx_get_card_state(card
, &state
);
298 } while (state
== CARD_STATE_STARTING
&&
299 (jiffies
- start
< timeout
));
301 if (state
== CARD_STATE_STARTING
)
304 /* Only issue a shutdown if we need to */
305 if ((state
!= CARD_STATE_SHUTTING_DOWN
) &&
306 (state
!= CARD_STATE_SHUTDOWN
)) {
307 st
= rsxx_issue_card_cmd(card
, CARD_CMD_SHUTDOWN
);
314 st
= rsxx_get_card_state(card
, &state
);
317 } while (state
!= CARD_STATE_SHUTDOWN
&&
318 (jiffies
- start
< timeout
));
320 if (state
!= CARD_STATE_SHUTDOWN
)
326 static int rsxx_eeh_frozen(struct pci_dev
*dev
)
328 struct rsxx_cardinfo
*card
= pci_get_drvdata(dev
);
332 dev_warn(&dev
->dev
, "IBM FlashSystem PCI: preparing for slot reset.\n");
335 rsxx_mask_interrupts(card
);
338 * We need to guarantee that the write for eeh_state and masking
339 * interrupts does not become reordered. This will prevent a possible
340 * race condition with the EEH code.
344 pci_disable_device(dev
);
346 st
= rsxx_eeh_save_issued_dmas(card
);
350 rsxx_eeh_save_issued_creg(card
);
352 for (i
= 0; i
< card
->n_targets
; i
++) {
353 if (card
->ctrl
[i
].status
.buf
)
354 pci_free_consistent(card
->dev
, STATUS_BUFFER_SIZE8
,
355 card
->ctrl
[i
].status
.buf
,
356 card
->ctrl
[i
].status
.dma_addr
);
357 if (card
->ctrl
[i
].cmd
.buf
)
358 pci_free_consistent(card
->dev
, COMMAND_BUFFER_SIZE8
,
359 card
->ctrl
[i
].cmd
.buf
,
360 card
->ctrl
[i
].cmd
.dma_addr
);
366 static void rsxx_eeh_failure(struct pci_dev
*dev
)
368 struct rsxx_cardinfo
*card
= pci_get_drvdata(dev
);
371 dev_err(&dev
->dev
, "IBM FlashSystem PCI: disabling failed card.\n");
375 for (i
= 0; i
< card
->n_targets
; i
++)
376 del_timer_sync(&card
->ctrl
[i
].activity_timer
);
378 rsxx_eeh_cancel_dmas(card
);
381 static int rsxx_eeh_fifo_flush_poll(struct rsxx_cardinfo
*card
)
386 /* We need to wait for the hardware to reset */
387 while (iter
++ < 10) {
388 status
= ioread32(card
->regmap
+ PCI_RECONFIG
);
390 if (status
& RSXX_FLUSH_BUSY
) {
395 if (status
& RSXX_FLUSH_TIMEOUT
)
396 dev_warn(CARD_TO_DEV(card
), "HW: flash controller timeout\n");
400 /* Hardware failed resetting itself. */
404 static pci_ers_result_t
rsxx_error_detected(struct pci_dev
*dev
,
405 enum pci_channel_state error
)
409 if (dev
->revision
< RSXX_EEH_SUPPORT
)
410 return PCI_ERS_RESULT_NONE
;
412 if (error
== pci_channel_io_perm_failure
) {
413 rsxx_eeh_failure(dev
);
414 return PCI_ERS_RESULT_DISCONNECT
;
417 st
= rsxx_eeh_frozen(dev
);
419 dev_err(&dev
->dev
, "Slot reset setup failed\n");
420 rsxx_eeh_failure(dev
);
421 return PCI_ERS_RESULT_DISCONNECT
;
424 return PCI_ERS_RESULT_NEED_RESET
;
427 static pci_ers_result_t
rsxx_slot_reset(struct pci_dev
*dev
)
429 struct rsxx_cardinfo
*card
= pci_get_drvdata(dev
);
435 "IBM FlashSystem PCI: recovering from slot reset.\n");
437 st
= pci_enable_device(dev
);
439 goto failed_hw_setup
;
443 st
= rsxx_eeh_fifo_flush_poll(card
);
445 goto failed_hw_setup
;
447 rsxx_dma_queue_reset(card
);
449 for (i
= 0; i
< card
->n_targets
; i
++) {
450 st
= rsxx_hw_buffers_init(dev
, &card
->ctrl
[i
]);
452 goto failed_hw_buffers_init
;
455 if (card
->config_valid
)
456 rsxx_dma_configure(card
);
458 /* Clears the ISR register from spurious interrupts */
459 st
= ioread32(card
->regmap
+ ISR
);
463 st
= rsxx_eeh_remap_dmas(card
);
465 goto failed_remap_dmas
;
467 spin_lock_irqsave(&card
->irq_lock
, flags
);
468 if (card
->n_targets
& RSXX_MAX_TARGETS
)
469 rsxx_enable_ier_and_isr(card
, CR_INTR_ALL_G
);
471 rsxx_enable_ier_and_isr(card
, CR_INTR_ALL_C
);
472 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
474 rsxx_kick_creg_queue(card
);
476 for (i
= 0; i
< card
->n_targets
; i
++) {
477 spin_lock(&card
->ctrl
[i
].queue_lock
);
478 if (list_empty(&card
->ctrl
[i
].queue
)) {
479 spin_unlock(&card
->ctrl
[i
].queue_lock
);
482 spin_unlock(&card
->ctrl
[i
].queue_lock
);
484 queue_work(card
->ctrl
[i
].issue_wq
,
485 &card
->ctrl
[i
].issue_dma_work
);
488 dev_info(&dev
->dev
, "IBM FlashSystem PCI: recovery complete.\n");
490 return PCI_ERS_RESULT_RECOVERED
;
492 failed_hw_buffers_init
:
494 for (i
= 0; i
< card
->n_targets
; i
++) {
495 if (card
->ctrl
[i
].status
.buf
)
496 pci_free_consistent(card
->dev
,
498 card
->ctrl
[i
].status
.buf
,
499 card
->ctrl
[i
].status
.dma_addr
);
500 if (card
->ctrl
[i
].cmd
.buf
)
501 pci_free_consistent(card
->dev
,
502 COMMAND_BUFFER_SIZE8
,
503 card
->ctrl
[i
].cmd
.buf
,
504 card
->ctrl
[i
].cmd
.dma_addr
);
507 rsxx_eeh_failure(dev
);
508 return PCI_ERS_RESULT_DISCONNECT
;
512 /*----------------- Driver Initialization & Setup -------------------*/
513 /* Returns: 0 if the driver is compatible with the device
514 -1 if the driver is NOT compatible with the device */
515 static int rsxx_compatibility_check(struct rsxx_cardinfo
*card
)
517 unsigned char pci_rev
;
519 pci_read_config_byte(card
->dev
, PCI_REVISION_ID
, &pci_rev
);
521 if (pci_rev
> RS70_PCI_REV_SUPPORTED
)
526 static int rsxx_pci_probe(struct pci_dev
*dev
,
527 const struct pci_device_id
*id
)
529 struct rsxx_cardinfo
*card
;
532 dev_info(&dev
->dev
, "PCI-Flash SSD discovered\n");
534 card
= kzalloc(sizeof(*card
), GFP_KERNEL
);
539 pci_set_drvdata(dev
, card
);
542 if (!ida_pre_get(&rsxx_disk_ida
, GFP_KERNEL
)) {
547 spin_lock(&rsxx_ida_lock
);
548 st
= ida_get_new(&rsxx_disk_ida
, &card
->disk_id
);
549 spin_unlock(&rsxx_ida_lock
);
550 } while (st
== -EAGAIN
);
555 st
= pci_enable_device(dev
);
560 pci_set_dma_max_seg_size(dev
, RSXX_HW_BLK_SIZE
);
562 st
= pci_set_dma_mask(dev
, DMA_BIT_MASK(64));
564 dev_err(CARD_TO_DEV(card
),
565 "No usable DMA configuration,aborting\n");
566 goto failed_dma_mask
;
569 st
= pci_request_regions(dev
, DRIVER_NAME
);
571 dev_err(CARD_TO_DEV(card
),
572 "Failed to request memory region\n");
573 goto failed_request_regions
;
576 if (pci_resource_len(dev
, 0) == 0) {
577 dev_err(CARD_TO_DEV(card
), "BAR0 has length 0!\n");
582 card
->regmap
= pci_iomap(dev
, 0, 0);
584 dev_err(CARD_TO_DEV(card
), "Failed to map BAR0\n");
589 spin_lock_init(&card
->irq_lock
);
593 spin_lock_irq(&card
->irq_lock
);
594 rsxx_disable_ier_and_isr(card
, CR_INTR_ALL
);
595 spin_unlock_irq(&card
->irq_lock
);
598 st
= pci_enable_msi(dev
);
600 dev_warn(CARD_TO_DEV(card
),
601 "Failed to enable MSI\n");
604 st
= request_irq(dev
->irq
, rsxx_isr
, IRQF_DISABLED
| IRQF_SHARED
,
607 dev_err(CARD_TO_DEV(card
),
608 "Failed requesting IRQ%d\n", dev
->irq
);
612 /************* Setup Processor Command Interface *************/
613 rsxx_creg_setup(card
);
615 spin_lock_irq(&card
->irq_lock
);
616 rsxx_enable_ier_and_isr(card
, CR_INTR_CREG
);
617 spin_unlock_irq(&card
->irq_lock
);
619 st
= rsxx_compatibility_check(card
);
621 dev_warn(CARD_TO_DEV(card
),
622 "Incompatible driver detected. Please update the driver.\n");
624 goto failed_compatiblity_check
;
627 /************* Load Card Config *************/
628 st
= rsxx_load_config(card
);
630 dev_err(CARD_TO_DEV(card
),
631 "Failed loading card config\n");
633 /************* Setup DMA Engine *************/
634 st
= rsxx_get_num_targets(card
, &card
->n_targets
);
636 dev_info(CARD_TO_DEV(card
),
637 "Failed reading the number of DMA targets\n");
639 card
->ctrl
= kzalloc(card
->n_targets
* sizeof(*card
->ctrl
), GFP_KERNEL
);
642 goto failed_dma_setup
;
645 st
= rsxx_dma_setup(card
);
647 dev_info(CARD_TO_DEV(card
),
648 "Failed to setup DMA engine\n");
649 goto failed_dma_setup
;
652 /************* Setup Card Event Handler *************/
653 INIT_WORK(&card
->event_work
, card_event_handler
);
655 st
= rsxx_setup_dev(card
);
657 goto failed_create_dev
;
659 rsxx_get_card_state(card
, &card
->state
);
661 dev_info(CARD_TO_DEV(card
),
663 rsxx_card_state_to_str(card
->state
));
666 * Now that the DMA Engine and devices have been setup,
667 * we can enable the event interrupt(it kicks off actions in
668 * those layers so we couldn't enable it right away.)
670 spin_lock_irq(&card
->irq_lock
);
671 rsxx_enable_ier_and_isr(card
, CR_INTR_EVENT
);
672 spin_unlock_irq(&card
->irq_lock
);
674 if (card
->state
== CARD_STATE_SHUTDOWN
) {
675 st
= rsxx_issue_card_cmd(card
, CARD_CMD_STARTUP
);
677 dev_crit(CARD_TO_DEV(card
),
678 "Failed issuing card startup\n");
679 } else if (card
->state
== CARD_STATE_GOOD
||
680 card
->state
== CARD_STATE_RD_ONLY_FAULT
) {
681 st
= rsxx_get_card_size8(card
, &card
->size8
);
686 rsxx_attach_dev(card
);
691 rsxx_dma_destroy(card
);
693 failed_compatiblity_check
:
694 spin_lock_irq(&card
->irq_lock
);
695 rsxx_disable_ier_and_isr(card
, CR_INTR_ALL
);
696 spin_unlock_irq(&card
->irq_lock
);
697 free_irq(dev
->irq
, card
);
699 pci_disable_msi(dev
);
701 pci_iounmap(dev
, card
->regmap
);
703 pci_release_regions(dev
);
704 failed_request_regions
:
706 pci_disable_device(dev
);
708 spin_lock(&rsxx_ida_lock
);
709 ida_remove(&rsxx_disk_ida
, card
->disk_id
);
710 spin_unlock(&rsxx_ida_lock
);
717 static void rsxx_pci_remove(struct pci_dev
*dev
)
719 struct rsxx_cardinfo
*card
= pci_get_drvdata(dev
);
727 dev_info(CARD_TO_DEV(card
),
728 "Removing PCI-Flash SSD.\n");
730 rsxx_detach_dev(card
);
732 for (i
= 0; i
< card
->n_targets
; i
++) {
733 spin_lock_irqsave(&card
->irq_lock
, flags
);
734 rsxx_disable_ier_and_isr(card
, CR_INTR_DMA(i
));
735 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
738 st
= card_shutdown(card
);
740 dev_crit(CARD_TO_DEV(card
), "Shutdown failed!\n");
742 /* Sync outstanding event handlers. */
743 spin_lock_irqsave(&card
->irq_lock
, flags
);
744 rsxx_disable_ier_and_isr(card
, CR_INTR_EVENT
);
745 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
747 cancel_work_sync(&card
->event_work
);
749 rsxx_destroy_dev(card
);
750 rsxx_dma_destroy(card
);
752 spin_lock_irqsave(&card
->irq_lock
, flags
);
753 rsxx_disable_ier_and_isr(card
, CR_INTR_ALL
);
754 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
756 /* Prevent work_structs from re-queuing themselves. */
759 free_irq(dev
->irq
, card
);
762 pci_disable_msi(dev
);
764 rsxx_creg_destroy(card
);
766 pci_iounmap(dev
, card
->regmap
);
768 pci_disable_device(dev
);
769 pci_release_regions(dev
);
774 static int rsxx_pci_suspend(struct pci_dev
*dev
, pm_message_t state
)
776 /* We don't support suspend at this time. */
780 static void rsxx_pci_shutdown(struct pci_dev
*dev
)
782 struct rsxx_cardinfo
*card
= pci_get_drvdata(dev
);
789 dev_info(CARD_TO_DEV(card
), "Shutting down PCI-Flash SSD.\n");
791 rsxx_detach_dev(card
);
793 for (i
= 0; i
< card
->n_targets
; i
++) {
794 spin_lock_irqsave(&card
->irq_lock
, flags
);
795 rsxx_disable_ier_and_isr(card
, CR_INTR_DMA(i
));
796 spin_unlock_irqrestore(&card
->irq_lock
, flags
);
802 static const struct pci_error_handlers rsxx_err_handler
= {
803 .error_detected
= rsxx_error_detected
,
804 .slot_reset
= rsxx_slot_reset
,
807 static DEFINE_PCI_DEVICE_TABLE(rsxx_pci_ids
) = {
808 {PCI_DEVICE(PCI_VENDOR_ID_IBM
, PCI_DEVICE_ID_FS70_FLASH
)},
809 {PCI_DEVICE(PCI_VENDOR_ID_IBM
, PCI_DEVICE_ID_FS80_FLASH
)},
813 MODULE_DEVICE_TABLE(pci
, rsxx_pci_ids
);
815 static struct pci_driver rsxx_pci_driver
= {
817 .id_table
= rsxx_pci_ids
,
818 .probe
= rsxx_pci_probe
,
819 .remove
= rsxx_pci_remove
,
820 .suspend
= rsxx_pci_suspend
,
821 .shutdown
= rsxx_pci_shutdown
,
822 .err_handler
= &rsxx_err_handler
,
825 static int __init
rsxx_core_init(void)
829 st
= rsxx_dev_init();
833 st
= rsxx_dma_init();
835 goto dma_init_failed
;
837 st
= rsxx_creg_init();
839 goto creg_init_failed
;
841 return pci_register_driver(&rsxx_pci_driver
);
851 static void __exit
rsxx_core_cleanup(void)
853 pci_unregister_driver(&rsxx_pci_driver
);
859 module_init(rsxx_core_init
);
860 module_exit(rsxx_core_cleanup
);