3 * Linux MegaRAID driver for SAS based RAID controllers
5 * Copyright (c) 2003-2005 LSI Corporation.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
12 * FILE : megaraid_sas.c
13 * Version : v00.00.03.20-rc1
16 * (email-id : megaraidlinux@lsi.com)
21 * List of supported controllers
23 * OEM Product Name VID DID SSVID SSID
24 * --- ------------ --- --- ---- ----
27 #include <linux/kernel.h>
28 #include <linux/types.h>
29 #include <linux/pci.h>
30 #include <linux/list.h>
31 #include <linux/moduleparam.h>
32 #include <linux/module.h>
33 #include <linux/spinlock.h>
34 #include <linux/interrupt.h>
35 #include <linux/delay.h>
36 #include <linux/smp_lock.h>
37 #include <linux/uio.h>
38 #include <asm/uaccess.h>
40 #include <linux/compat.h>
41 #include <linux/blkdev.h>
42 #include <linux/mutex.h>
44 #include <scsi/scsi.h>
45 #include <scsi/scsi_cmnd.h>
46 #include <scsi/scsi_device.h>
47 #include <scsi/scsi_host.h>
48 #include "megaraid_sas.h"
51 * poll_mode_io:1- schedule complete completion from q cmd
53 static unsigned int poll_mode_io;
54 module_param_named(poll_mode_io, poll_mode_io, int, 0);
55 MODULE_PARM_DESC(poll_mode_io,
56 "Complete cmds from IO path, (default=0)");
58 MODULE_LICENSE("GPL");
59 MODULE_VERSION(MEGASAS_VERSION);
60 MODULE_AUTHOR("megaraidlinux@lsi.com");
61 MODULE_DESCRIPTION("LSI MegaRAID SAS Driver");
64 * PCI ID table for all supported controllers
66 static struct pci_device_id megasas_pci_table[] = {
68 {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1064R)},
70 {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1078R)},
72 {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1078DE)},
74 {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_VERDE_ZCR)},
75 /* xscale IOP, vega */
76 {PCI_DEVICE(PCI_VENDOR_ID_DELL, PCI_DEVICE_ID_DELL_PERC5)},
81 MODULE_DEVICE_TABLE(pci, megasas_pci_table);
83 static int megasas_mgmt_majorno;
84 static struct megasas_mgmt_info megasas_mgmt_info;
85 static struct fasync_struct *megasas_async_queue;
86 static DEFINE_MUTEX(megasas_async_queue_mutex);
88 static u32 megasas_dbg_lvl;
91 megasas_complete_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd,
95 * megasas_get_cmd - Get a command from the free pool
96 * @instance: Adapter soft state
98 * Returns a free command from the pool
100 static struct megasas_cmd *megasas_get_cmd(struct megasas_instance
104 struct megasas_cmd *cmd = NULL;
106 spin_lock_irqsave(&instance->cmd_pool_lock, flags);
108 if (!list_empty(&instance->cmd_pool)) {
109 cmd = list_entry((&instance->cmd_pool)->next,
110 struct megasas_cmd, list);
111 list_del_init(&cmd->list);
113 printk(KERN_ERR "megasas: Command pool empty!\n");
116 spin_unlock_irqrestore(&instance->cmd_pool_lock, flags);
121 * megasas_return_cmd - Return a cmd to free command pool
122 * @instance: Adapter soft state
123 * @cmd: Command packet to be returned to free command pool
126 megasas_return_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd)
130 spin_lock_irqsave(&instance->cmd_pool_lock, flags);
133 list_add_tail(&cmd->list, &instance->cmd_pool);
135 spin_unlock_irqrestore(&instance->cmd_pool_lock, flags);
140 * The following functions are defined for xscale
141 * (deviceid : 1064R, PERC5) controllers
145 * megasas_enable_intr_xscale - Enables interrupts
146 * @regs: MFI register set
149 megasas_enable_intr_xscale(struct megasas_register_set __iomem * regs)
151 writel(1, &(regs)->outbound_intr_mask);
153 /* Dummy readl to force pci flush */
154 readl(®s->outbound_intr_mask);
158 * megasas_disable_intr_xscale -Disables interrupt
159 * @regs: MFI register set
162 megasas_disable_intr_xscale(struct megasas_register_set __iomem * regs)
165 writel(mask, ®s->outbound_intr_mask);
166 /* Dummy readl to force pci flush */
167 readl(®s->outbound_intr_mask);
171 * megasas_read_fw_status_reg_xscale - returns the current FW status value
172 * @regs: MFI register set
175 megasas_read_fw_status_reg_xscale(struct megasas_register_set __iomem * regs)
177 return readl(&(regs)->outbound_msg_0);
180 * megasas_clear_interrupt_xscale - Check & clear interrupt
181 * @regs: MFI register set
184 megasas_clear_intr_xscale(struct megasas_register_set __iomem * regs)
188 * Check if it is our interrupt
190 status = readl(®s->outbound_intr_status);
192 if (!(status & MFI_OB_INTR_STATUS_MASK)) {
197 * Clear the interrupt by writing back the same value
199 writel(status, ®s->outbound_intr_status);
201 /* Dummy readl to force pci flush */
202 readl(®s->outbound_intr_status);
208 * megasas_fire_cmd_xscale - Sends command to the FW
209 * @frame_phys_addr : Physical address of cmd
210 * @frame_count : Number of frames for the command
211 * @regs : MFI register set
214 megasas_fire_cmd_xscale(dma_addr_t frame_phys_addr,u32 frame_count, struct megasas_register_set __iomem *regs)
216 writel((frame_phys_addr >> 3)|(frame_count),
217 &(regs)->inbound_queue_port);
220 static struct megasas_instance_template megasas_instance_template_xscale = {
222 .fire_cmd = megasas_fire_cmd_xscale,
223 .enable_intr = megasas_enable_intr_xscale,
224 .disable_intr = megasas_disable_intr_xscale,
225 .clear_intr = megasas_clear_intr_xscale,
226 .read_fw_status_reg = megasas_read_fw_status_reg_xscale,
230 * This is the end of set of functions & definitions specific
231 * to xscale (deviceid : 1064R, PERC5) controllers
235 * The following functions are defined for ppc (deviceid : 0x60)
240 * megasas_enable_intr_ppc - Enables interrupts
241 * @regs: MFI register set
244 megasas_enable_intr_ppc(struct megasas_register_set __iomem * regs)
246 writel(0xFFFFFFFF, &(regs)->outbound_doorbell_clear);
248 writel(~0x80000004, &(regs)->outbound_intr_mask);
250 /* Dummy readl to force pci flush */
251 readl(®s->outbound_intr_mask);
255 * megasas_disable_intr_ppc - Disable interrupt
256 * @regs: MFI register set
259 megasas_disable_intr_ppc(struct megasas_register_set __iomem * regs)
261 u32 mask = 0xFFFFFFFF;
262 writel(mask, ®s->outbound_intr_mask);
263 /* Dummy readl to force pci flush */
264 readl(®s->outbound_intr_mask);
268 * megasas_read_fw_status_reg_ppc - returns the current FW status value
269 * @regs: MFI register set
272 megasas_read_fw_status_reg_ppc(struct megasas_register_set __iomem * regs)
274 return readl(&(regs)->outbound_scratch_pad);
278 * megasas_clear_interrupt_ppc - Check & clear interrupt
279 * @regs: MFI register set
282 megasas_clear_intr_ppc(struct megasas_register_set __iomem * regs)
286 * Check if it is our interrupt
288 status = readl(®s->outbound_intr_status);
290 if (!(status & MFI_REPLY_1078_MESSAGE_INTERRUPT)) {
295 * Clear the interrupt by writing back the same value
297 writel(status, ®s->outbound_doorbell_clear);
299 /* Dummy readl to force pci flush */
300 readl(®s->outbound_doorbell_clear);
305 * megasas_fire_cmd_ppc - Sends command to the FW
306 * @frame_phys_addr : Physical address of cmd
307 * @frame_count : Number of frames for the command
308 * @regs : MFI register set
311 megasas_fire_cmd_ppc(dma_addr_t frame_phys_addr, u32 frame_count, struct megasas_register_set __iomem *regs)
313 writel((frame_phys_addr | (frame_count<<1))|1,
314 &(regs)->inbound_queue_port);
317 static struct megasas_instance_template megasas_instance_template_ppc = {
319 .fire_cmd = megasas_fire_cmd_ppc,
320 .enable_intr = megasas_enable_intr_ppc,
321 .disable_intr = megasas_disable_intr_ppc,
322 .clear_intr = megasas_clear_intr_ppc,
323 .read_fw_status_reg = megasas_read_fw_status_reg_ppc,
327 * This is the end of set of functions & definitions
328 * specific to ppc (deviceid : 0x60) controllers
332 * megasas_issue_polled - Issues a polling command
333 * @instance: Adapter soft state
334 * @cmd: Command packet to be issued
336 * For polling, MFI requires the cmd_status to be set to 0xFF before posting.
339 megasas_issue_polled(struct megasas_instance *instance, struct megasas_cmd *cmd)
342 u32 msecs = MFI_POLL_TIMEOUT_SECS * 1000;
344 struct megasas_header *frame_hdr = &cmd->frame->hdr;
346 frame_hdr->cmd_status = 0xFF;
347 frame_hdr->flags |= MFI_FRAME_DONT_POST_IN_REPLY_QUEUE;
350 * Issue the frame using inbound queue port
352 instance->instancet->fire_cmd(cmd->frame_phys_addr ,0,instance->reg_set);
355 * Wait for cmd_status to change
357 for (i = 0; (i < msecs) && (frame_hdr->cmd_status == 0xff); i++) {
362 if (frame_hdr->cmd_status == 0xff)
369 * megasas_issue_blocked_cmd - Synchronous wrapper around regular FW cmds
370 * @instance: Adapter soft state
371 * @cmd: Command to be issued
373 * This function waits on an event for the command to be returned from ISR.
374 * Max wait time is MEGASAS_INTERNAL_CMD_WAIT_TIME secs
375 * Used to issue ioctl commands.
378 megasas_issue_blocked_cmd(struct megasas_instance *instance,
379 struct megasas_cmd *cmd)
381 cmd->cmd_status = ENODATA;
383 instance->instancet->fire_cmd(cmd->frame_phys_addr ,0,instance->reg_set);
385 wait_event_timeout(instance->int_cmd_wait_q, (cmd->cmd_status != ENODATA),
386 MEGASAS_INTERNAL_CMD_WAIT_TIME*HZ);
392 * megasas_issue_blocked_abort_cmd - Aborts previously issued cmd
393 * @instance: Adapter soft state
394 * @cmd_to_abort: Previously issued cmd to be aborted
396 * MFI firmware can abort previously issued AEN comamnd (automatic event
397 * notification). The megasas_issue_blocked_abort_cmd() issues such abort
398 * cmd and waits for return status.
399 * Max wait time is MEGASAS_INTERNAL_CMD_WAIT_TIME secs
402 megasas_issue_blocked_abort_cmd(struct megasas_instance *instance,
403 struct megasas_cmd *cmd_to_abort)
405 struct megasas_cmd *cmd;
406 struct megasas_abort_frame *abort_fr;
408 cmd = megasas_get_cmd(instance);
413 abort_fr = &cmd->frame->abort;
416 * Prepare and issue the abort frame
418 abort_fr->cmd = MFI_CMD_ABORT;
419 abort_fr->cmd_status = 0xFF;
421 abort_fr->abort_context = cmd_to_abort->index;
422 abort_fr->abort_mfi_phys_addr_lo = cmd_to_abort->frame_phys_addr;
423 abort_fr->abort_mfi_phys_addr_hi = 0;
426 cmd->cmd_status = 0xFF;
428 instance->instancet->fire_cmd(cmd->frame_phys_addr ,0,instance->reg_set);
431 * Wait for this cmd to complete
433 wait_event_timeout(instance->abort_cmd_wait_q, (cmd->cmd_status != 0xFF),
434 MEGASAS_INTERNAL_CMD_WAIT_TIME*HZ);
436 megasas_return_cmd(instance, cmd);
441 * megasas_make_sgl32 - Prepares 32-bit SGL
442 * @instance: Adapter soft state
443 * @scp: SCSI command from the mid-layer
444 * @mfi_sgl: SGL to be filled in
446 * If successful, this function returns the number of SG elements. Otherwise,
450 megasas_make_sgl32(struct megasas_instance *instance, struct scsi_cmnd *scp,
451 union megasas_sgl *mfi_sgl)
455 struct scatterlist *os_sgl;
457 sge_count = scsi_dma_map(scp);
458 BUG_ON(sge_count < 0);
461 scsi_for_each_sg(scp, os_sgl, sge_count, i) {
462 mfi_sgl->sge32[i].length = sg_dma_len(os_sgl);
463 mfi_sgl->sge32[i].phys_addr = sg_dma_address(os_sgl);
470 * megasas_make_sgl64 - Prepares 64-bit SGL
471 * @instance: Adapter soft state
472 * @scp: SCSI command from the mid-layer
473 * @mfi_sgl: SGL to be filled in
475 * If successful, this function returns the number of SG elements. Otherwise,
479 megasas_make_sgl64(struct megasas_instance *instance, struct scsi_cmnd *scp,
480 union megasas_sgl *mfi_sgl)
484 struct scatterlist *os_sgl;
486 sge_count = scsi_dma_map(scp);
487 BUG_ON(sge_count < 0);
490 scsi_for_each_sg(scp, os_sgl, sge_count, i) {
491 mfi_sgl->sge64[i].length = sg_dma_len(os_sgl);
492 mfi_sgl->sge64[i].phys_addr = sg_dma_address(os_sgl);
499 * megasas_get_frame_count - Computes the number of frames
500 * @frame_type : type of frame- io or pthru frame
501 * @sge_count : number of sg elements
503 * Returns the number of frames required for numnber of sge's (sge_count)
506 static u32 megasas_get_frame_count(u8 sge_count, u8 frame_type)
513 sge_sz = (IS_DMA64) ? sizeof(struct megasas_sge64) :
514 sizeof(struct megasas_sge32);
517 * Main frame can contain 2 SGEs for 64-bit SGLs and
518 * 3 SGEs for 32-bit SGLs for ldio &
519 * 1 SGEs for 64-bit SGLs and
520 * 2 SGEs for 32-bit SGLs for pthru frame
522 if (unlikely(frame_type == PTHRU_FRAME)) {
524 num_cnt = sge_count - 1;
526 num_cnt = sge_count - 2;
529 num_cnt = sge_count - 2;
531 num_cnt = sge_count - 3;
535 sge_bytes = sge_sz * num_cnt;
537 frame_count = (sge_bytes / MEGAMFI_FRAME_SIZE) +
538 ((sge_bytes % MEGAMFI_FRAME_SIZE) ? 1 : 0) ;
549 * megasas_build_dcdb - Prepares a direct cdb (DCDB) command
550 * @instance: Adapter soft state
552 * @cmd: Command to be prepared in
554 * This function prepares CDB commands. These are typcially pass-through
555 * commands to the devices.
558 megasas_build_dcdb(struct megasas_instance *instance, struct scsi_cmnd *scp,
559 struct megasas_cmd *cmd)
564 struct megasas_pthru_frame *pthru;
566 is_logical = MEGASAS_IS_LOGICAL(scp);
567 device_id = MEGASAS_DEV_INDEX(instance, scp);
568 pthru = (struct megasas_pthru_frame *)cmd->frame;
570 if (scp->sc_data_direction == PCI_DMA_TODEVICE)
571 flags = MFI_FRAME_DIR_WRITE;
572 else if (scp->sc_data_direction == PCI_DMA_FROMDEVICE)
573 flags = MFI_FRAME_DIR_READ;
574 else if (scp->sc_data_direction == PCI_DMA_NONE)
575 flags = MFI_FRAME_DIR_NONE;
578 * Prepare the DCDB frame
580 pthru->cmd = (is_logical) ? MFI_CMD_LD_SCSI_IO : MFI_CMD_PD_SCSI_IO;
581 pthru->cmd_status = 0x0;
582 pthru->scsi_status = 0x0;
583 pthru->target_id = device_id;
584 pthru->lun = scp->device->lun;
585 pthru->cdb_len = scp->cmd_len;
587 pthru->flags = flags;
588 pthru->data_xfer_len = scsi_bufflen(scp);
590 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
596 pthru->flags |= MFI_FRAME_SGL64;
597 pthru->sge_count = megasas_make_sgl64(instance, scp,
600 pthru->sge_count = megasas_make_sgl32(instance, scp,
604 * Sense info specific
606 pthru->sense_len = SCSI_SENSE_BUFFERSIZE;
607 pthru->sense_buf_phys_addr_hi = 0;
608 pthru->sense_buf_phys_addr_lo = cmd->sense_phys_addr;
611 * Compute the total number of frames this command consumes. FW uses
612 * this number to pull sufficient number of frames from host memory.
614 cmd->frame_count = megasas_get_frame_count(pthru->sge_count,
617 return cmd->frame_count;
621 * megasas_build_ldio - Prepares IOs to logical devices
622 * @instance: Adapter soft state
624 * @cmd: Command to to be prepared
626 * Frames (and accompanying SGLs) for regular SCSI IOs use this function.
629 megasas_build_ldio(struct megasas_instance *instance, struct scsi_cmnd *scp,
630 struct megasas_cmd *cmd)
633 u8 sc = scp->cmnd[0];
635 struct megasas_io_frame *ldio;
637 device_id = MEGASAS_DEV_INDEX(instance, scp);
638 ldio = (struct megasas_io_frame *)cmd->frame;
640 if (scp->sc_data_direction == PCI_DMA_TODEVICE)
641 flags = MFI_FRAME_DIR_WRITE;
642 else if (scp->sc_data_direction == PCI_DMA_FROMDEVICE)
643 flags = MFI_FRAME_DIR_READ;
646 * Prepare the Logical IO frame: 2nd bit is zero for all read cmds
648 ldio->cmd = (sc & 0x02) ? MFI_CMD_LD_WRITE : MFI_CMD_LD_READ;
649 ldio->cmd_status = 0x0;
650 ldio->scsi_status = 0x0;
651 ldio->target_id = device_id;
653 ldio->reserved_0 = 0;
656 ldio->start_lba_hi = 0;
657 ldio->access_byte = (scp->cmd_len != 6) ? scp->cmnd[1] : 0;
660 * 6-byte READ(0x08) or WRITE(0x0A) cdb
662 if (scp->cmd_len == 6) {
663 ldio->lba_count = (u32) scp->cmnd[4];
664 ldio->start_lba_lo = ((u32) scp->cmnd[1] << 16) |
665 ((u32) scp->cmnd[2] << 8) | (u32) scp->cmnd[3];
667 ldio->start_lba_lo &= 0x1FFFFF;
671 * 10-byte READ(0x28) or WRITE(0x2A) cdb
673 else if (scp->cmd_len == 10) {
674 ldio->lba_count = (u32) scp->cmnd[8] |
675 ((u32) scp->cmnd[7] << 8);
676 ldio->start_lba_lo = ((u32) scp->cmnd[2] << 24) |
677 ((u32) scp->cmnd[3] << 16) |
678 ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];
682 * 12-byte READ(0xA8) or WRITE(0xAA) cdb
684 else if (scp->cmd_len == 12) {
685 ldio->lba_count = ((u32) scp->cmnd[6] << 24) |
686 ((u32) scp->cmnd[7] << 16) |
687 ((u32) scp->cmnd[8] << 8) | (u32) scp->cmnd[9];
689 ldio->start_lba_lo = ((u32) scp->cmnd[2] << 24) |
690 ((u32) scp->cmnd[3] << 16) |
691 ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];
695 * 16-byte READ(0x88) or WRITE(0x8A) cdb
697 else if (scp->cmd_len == 16) {
698 ldio->lba_count = ((u32) scp->cmnd[10] << 24) |
699 ((u32) scp->cmnd[11] << 16) |
700 ((u32) scp->cmnd[12] << 8) | (u32) scp->cmnd[13];
702 ldio->start_lba_lo = ((u32) scp->cmnd[6] << 24) |
703 ((u32) scp->cmnd[7] << 16) |
704 ((u32) scp->cmnd[8] << 8) | (u32) scp->cmnd[9];
706 ldio->start_lba_hi = ((u32) scp->cmnd[2] << 24) |
707 ((u32) scp->cmnd[3] << 16) |
708 ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];
716 ldio->flags |= MFI_FRAME_SGL64;
717 ldio->sge_count = megasas_make_sgl64(instance, scp, &ldio->sgl);
719 ldio->sge_count = megasas_make_sgl32(instance, scp, &ldio->sgl);
722 * Sense info specific
724 ldio->sense_len = SCSI_SENSE_BUFFERSIZE;
725 ldio->sense_buf_phys_addr_hi = 0;
726 ldio->sense_buf_phys_addr_lo = cmd->sense_phys_addr;
729 * Compute the total number of frames this command consumes. FW uses
730 * this number to pull sufficient number of frames from host memory.
732 cmd->frame_count = megasas_get_frame_count(ldio->sge_count, IO_FRAME);
734 return cmd->frame_count;
738 * megasas_is_ldio - Checks if the cmd is for logical drive
739 * @scmd: SCSI command
741 * Called by megasas_queue_command to find out if the command to be queued
742 * is a logical drive command
744 static inline int megasas_is_ldio(struct scsi_cmnd *cmd)
746 if (!MEGASAS_IS_LOGICAL(cmd))
748 switch (cmd->cmnd[0]) {
764 * megasas_dump_pending_frames - Dumps the frame address of all pending cmds
766 * @instance: Adapter soft state
769 megasas_dump_pending_frames(struct megasas_instance *instance)
771 struct megasas_cmd *cmd;
773 union megasas_sgl *mfi_sgl;
774 struct megasas_io_frame *ldio;
775 struct megasas_pthru_frame *pthru;
777 u32 max_cmd = instance->max_fw_cmds;
779 printk(KERN_ERR "\nmegasas[%d]: Dumping Frame Phys Address of all pending cmds in FW\n",instance->host->host_no);
780 printk(KERN_ERR "megasas[%d]: Total OS Pending cmds : %d\n",instance->host->host_no,atomic_read(&instance->fw_outstanding));
782 printk(KERN_ERR "\nmegasas[%d]: 64 bit SGLs were sent to FW\n",instance->host->host_no);
784 printk(KERN_ERR "\nmegasas[%d]: 32 bit SGLs were sent to FW\n",instance->host->host_no);
786 printk(KERN_ERR "megasas[%d]: Pending OS cmds in FW : \n",instance->host->host_no);
787 for (i = 0; i < max_cmd; i++) {
788 cmd = instance->cmd_list[i];
791 printk(KERN_ERR "megasas[%d]: Frame addr :0x%08lx : ",instance->host->host_no,(unsigned long)cmd->frame_phys_addr);
792 if (megasas_is_ldio(cmd->scmd)){
793 ldio = (struct megasas_io_frame *)cmd->frame;
794 mfi_sgl = &ldio->sgl;
795 sgcount = ldio->sge_count;
796 printk(KERN_ERR "megasas[%d]: frame count : 0x%x, Cmd : 0x%x, Tgt id : 0x%x, lba lo : 0x%x, lba_hi : 0x%x, sense_buf addr : 0x%x,sge count : 0x%x\n",instance->host->host_no, cmd->frame_count,ldio->cmd,ldio->target_id, ldio->start_lba_lo,ldio->start_lba_hi,ldio->sense_buf_phys_addr_lo,sgcount);
799 pthru = (struct megasas_pthru_frame *) cmd->frame;
800 mfi_sgl = &pthru->sgl;
801 sgcount = pthru->sge_count;
802 printk(KERN_ERR "megasas[%d]: frame count : 0x%x, Cmd : 0x%x, Tgt id : 0x%x, lun : 0x%x, cdb_len : 0x%x, data xfer len : 0x%x, sense_buf addr : 0x%x,sge count : 0x%x\n",instance->host->host_no,cmd->frame_count,pthru->cmd,pthru->target_id,pthru->lun,pthru->cdb_len , pthru->data_xfer_len,pthru->sense_buf_phys_addr_lo,sgcount);
804 if(megasas_dbg_lvl & MEGASAS_DBG_LVL){
805 for (n = 0; n < sgcount; n++){
807 printk(KERN_ERR "megasas: sgl len : 0x%x, sgl addr : 0x%08lx ",mfi_sgl->sge64[n].length , (unsigned long)mfi_sgl->sge64[n].phys_addr) ;
809 printk(KERN_ERR "megasas: sgl len : 0x%x, sgl addr : 0x%x ",mfi_sgl->sge32[n].length , mfi_sgl->sge32[n].phys_addr) ;
812 printk(KERN_ERR "\n");
814 printk(KERN_ERR "\nmegasas[%d]: Pending Internal cmds in FW : \n",instance->host->host_no);
815 for (i = 0; i < max_cmd; i++) {
817 cmd = instance->cmd_list[i];
819 if(cmd->sync_cmd == 1){
820 printk(KERN_ERR "0x%08lx : ", (unsigned long)cmd->frame_phys_addr);
823 printk(KERN_ERR "megasas[%d]: Dumping Done.\n\n",instance->host->host_no);
827 * megasas_queue_command - Queue entry point
828 * @scmd: SCSI command to be queued
829 * @done: Callback entry point
832 megasas_queue_command(struct scsi_cmnd *scmd, void (*done) (struct scsi_cmnd *))
835 struct megasas_cmd *cmd;
836 struct megasas_instance *instance;
838 instance = (struct megasas_instance *)
839 scmd->device->host->hostdata;
841 /* Don't process if we have already declared adapter dead */
842 if (instance->hw_crit_error)
843 return SCSI_MLQUEUE_HOST_BUSY;
845 scmd->scsi_done = done;
848 if (MEGASAS_IS_LOGICAL(scmd) &&
849 (scmd->device->id >= MEGASAS_MAX_LD || scmd->device->lun)) {
850 scmd->result = DID_BAD_TARGET << 16;
854 switch (scmd->cmnd[0]) {
855 case SYNCHRONIZE_CACHE:
857 * FW takes care of flush cache on its own
858 * No need to send it down
860 scmd->result = DID_OK << 16;
866 cmd = megasas_get_cmd(instance);
868 return SCSI_MLQUEUE_HOST_BUSY;
871 * Logical drive command
873 if (megasas_is_ldio(scmd))
874 frame_count = megasas_build_ldio(instance, scmd, cmd);
876 frame_count = megasas_build_dcdb(instance, scmd, cmd);
882 scmd->SCp.ptr = (char *)cmd;
885 * Issue the command to the FW
887 atomic_inc(&instance->fw_outstanding);
889 instance->instancet->fire_cmd(cmd->frame_phys_addr ,cmd->frame_count-1,instance->reg_set);
891 * Check if we have pend cmds to be completed
893 if (poll_mode_io && atomic_read(&instance->fw_outstanding))
894 tasklet_schedule(&instance->isr_tasklet);
900 megasas_return_cmd(instance, cmd);
906 static int megasas_slave_configure(struct scsi_device *sdev)
909 * Don't export physical disk devices to the disk driver.
911 * FIXME: Currently we don't export them to the midlayer at all.
912 * That will be fixed once LSI engineers have audited the
913 * firmware for possible issues.
915 if (sdev->channel < MEGASAS_MAX_PD_CHANNELS && sdev->type == TYPE_DISK)
919 * The RAID firmware may require extended timeouts.
921 if (sdev->channel >= MEGASAS_MAX_PD_CHANNELS)
922 sdev->timeout = MEGASAS_DEFAULT_CMD_TIMEOUT * HZ;
927 * megasas_complete_cmd_dpc - Returns FW's controller structure
928 * @instance_addr: Address of adapter soft state
930 * Tasklet to complete cmds
932 static void megasas_complete_cmd_dpc(unsigned long instance_addr)
937 struct megasas_cmd *cmd;
938 struct megasas_instance *instance =
939 (struct megasas_instance *)instance_addr;
942 /* If we have already declared adapter dead, donot complete cmds */
943 if (instance->hw_crit_error)
946 spin_lock_irqsave(&instance->completion_lock, flags);
948 producer = *instance->producer;
949 consumer = *instance->consumer;
951 while (consumer != producer) {
952 context = instance->reply_queue[consumer];
954 cmd = instance->cmd_list[context];
956 megasas_complete_cmd(instance, cmd, DID_OK);
959 if (consumer == (instance->max_fw_cmds + 1)) {
964 *instance->consumer = producer;
966 spin_unlock_irqrestore(&instance->completion_lock, flags);
969 * Check if we can restore can_queue
971 if (instance->flag & MEGASAS_FW_BUSY
972 && time_after(jiffies, instance->last_time + 5 * HZ)
973 && atomic_read(&instance->fw_outstanding) < 17) {
975 spin_lock_irqsave(instance->host->host_lock, flags);
976 instance->flag &= ~MEGASAS_FW_BUSY;
977 instance->host->can_queue =
978 instance->max_fw_cmds - MEGASAS_INT_CMDS;
980 spin_unlock_irqrestore(instance->host->host_lock, flags);
985 * megasas_wait_for_outstanding - Wait for all outstanding cmds
986 * @instance: Adapter soft state
988 * This function waits for upto MEGASAS_RESET_WAIT_TIME seconds for FW to
989 * complete all its outstanding commands. Returns error if one or more IOs
990 * are pending after this time period. It also marks the controller dead.
992 static int megasas_wait_for_outstanding(struct megasas_instance *instance)
995 u32 wait_time = MEGASAS_RESET_WAIT_TIME;
997 for (i = 0; i < wait_time; i++) {
999 int outstanding = atomic_read(&instance->fw_outstanding);
1004 if (!(i % MEGASAS_RESET_NOTICE_INTERVAL)) {
1005 printk(KERN_NOTICE "megasas: [%2d]waiting for %d "
1006 "commands to complete\n",i,outstanding);
1008 * Call cmd completion routine. Cmd to be
1009 * be completed directly without depending on isr.
1011 megasas_complete_cmd_dpc((unsigned long)instance);
1017 if (atomic_read(&instance->fw_outstanding)) {
1019 * Send signal to FW to stop processing any pending cmds.
1020 * The controller will be taken offline by the OS now.
1022 writel(MFI_STOP_ADP,
1023 &instance->reg_set->inbound_doorbell);
1024 megasas_dump_pending_frames(instance);
1025 instance->hw_crit_error = 1;
1033 * megasas_generic_reset - Generic reset routine
1034 * @scmd: Mid-layer SCSI command
1036 * This routine implements a generic reset handler for device, bus and host
1037 * reset requests. Device, bus and host specific reset handlers can use this
1038 * function after they do their specific tasks.
1040 static int megasas_generic_reset(struct scsi_cmnd *scmd)
1043 struct megasas_instance *instance;
1045 instance = (struct megasas_instance *)scmd->device->host->hostdata;
1047 scmd_printk(KERN_NOTICE, scmd, "megasas: RESET -%ld cmd=%x retries=%x\n",
1048 scmd->serial_number, scmd->cmnd[0], scmd->retries);
1050 if (instance->hw_crit_error) {
1051 printk(KERN_ERR "megasas: cannot recover from previous reset "
1056 ret_val = megasas_wait_for_outstanding(instance);
1057 if (ret_val == SUCCESS)
1058 printk(KERN_NOTICE "megasas: reset successful \n");
1060 printk(KERN_ERR "megasas: failed to do reset\n");
1066 * megasas_reset_timer - quiesce the adapter if required
1069 * Sets the FW busy flag and reduces the host->can_queue if the
1070 * cmd has not been completed within the timeout period.
1073 scsi_eh_timer_return megasas_reset_timer(struct scsi_cmnd *scmd)
1075 struct megasas_cmd *cmd = (struct megasas_cmd *)scmd->SCp.ptr;
1076 struct megasas_instance *instance;
1077 unsigned long flags;
1079 if (time_after(jiffies, scmd->jiffies_at_alloc +
1080 (MEGASAS_DEFAULT_CMD_TIMEOUT * 2) * HZ)) {
1081 return EH_NOT_HANDLED;
1084 instance = cmd->instance;
1085 if (!(instance->flag & MEGASAS_FW_BUSY)) {
1086 /* FW is busy, throttle IO */
1087 spin_lock_irqsave(instance->host->host_lock, flags);
1089 instance->host->can_queue = 16;
1090 instance->last_time = jiffies;
1091 instance->flag |= MEGASAS_FW_BUSY;
1093 spin_unlock_irqrestore(instance->host->host_lock, flags);
1095 return EH_RESET_TIMER;
1099 * megasas_reset_device - Device reset handler entry point
1101 static int megasas_reset_device(struct scsi_cmnd *scmd)
1106 * First wait for all commands to complete
1108 ret = megasas_generic_reset(scmd);
1114 * megasas_reset_bus_host - Bus & host reset handler entry point
1116 static int megasas_reset_bus_host(struct scsi_cmnd *scmd)
1121 * First wait for all commands to complete
1123 ret = megasas_generic_reset(scmd);
1129 * megasas_bios_param - Returns disk geometry for a disk
1130 * @sdev: device handle
1131 * @bdev: block device
1132 * @capacity: drive capacity
1133 * @geom: geometry parameters
1136 megasas_bios_param(struct scsi_device *sdev, struct block_device *bdev,
1137 sector_t capacity, int geom[])
1143 /* Default heads (64) & sectors (32) */
1147 tmp = heads * sectors;
1148 cylinders = capacity;
1150 sector_div(cylinders, tmp);
1153 * Handle extended translation size for logical drives > 1Gb
1156 if (capacity >= 0x200000) {
1159 tmp = heads*sectors;
1160 cylinders = capacity;
1161 sector_div(cylinders, tmp);
1166 geom[2] = cylinders;
1172 * megasas_service_aen - Processes an event notification
1173 * @instance: Adapter soft state
1174 * @cmd: AEN command completed by the ISR
1176 * For AEN, driver sends a command down to FW that is held by the FW till an
1177 * event occurs. When an event of interest occurs, FW completes the command
1178 * that it was previously holding.
1180 * This routines sends SIGIO signal to processes that have registered with the
1184 megasas_service_aen(struct megasas_instance *instance, struct megasas_cmd *cmd)
1187 * Don't signal app if it is just an aborted previously registered aen
1189 if (!cmd->abort_aen)
1190 kill_fasync(&megasas_async_queue, SIGIO, POLL_IN);
1194 instance->aen_cmd = NULL;
1195 megasas_return_cmd(instance, cmd);
1199 * Scsi host template for megaraid_sas driver
1201 static struct scsi_host_template megasas_template = {
1203 .module = THIS_MODULE,
1204 .name = "LSI SAS based MegaRAID driver",
1205 .proc_name = "megaraid_sas",
1206 .slave_configure = megasas_slave_configure,
1207 .queuecommand = megasas_queue_command,
1208 .eh_device_reset_handler = megasas_reset_device,
1209 .eh_bus_reset_handler = megasas_reset_bus_host,
1210 .eh_host_reset_handler = megasas_reset_bus_host,
1211 .eh_timed_out = megasas_reset_timer,
1212 .bios_param = megasas_bios_param,
1213 .use_clustering = ENABLE_CLUSTERING,
1217 * megasas_complete_int_cmd - Completes an internal command
1218 * @instance: Adapter soft state
1219 * @cmd: Command to be completed
1221 * The megasas_issue_blocked_cmd() function waits for a command to complete
1222 * after it issues a command. This function wakes up that waiting routine by
1223 * calling wake_up() on the wait queue.
1226 megasas_complete_int_cmd(struct megasas_instance *instance,
1227 struct megasas_cmd *cmd)
1229 cmd->cmd_status = cmd->frame->io.cmd_status;
1231 if (cmd->cmd_status == ENODATA) {
1232 cmd->cmd_status = 0;
1234 wake_up(&instance->int_cmd_wait_q);
1238 * megasas_complete_abort - Completes aborting a command
1239 * @instance: Adapter soft state
1240 * @cmd: Cmd that was issued to abort another cmd
1242 * The megasas_issue_blocked_abort_cmd() function waits on abort_cmd_wait_q
1243 * after it issues an abort on a previously issued command. This function
1244 * wakes up all functions waiting on the same wait queue.
1247 megasas_complete_abort(struct megasas_instance *instance,
1248 struct megasas_cmd *cmd)
1250 if (cmd->sync_cmd) {
1252 cmd->cmd_status = 0;
1253 wake_up(&instance->abort_cmd_wait_q);
1260 * megasas_complete_cmd - Completes a command
1261 * @instance: Adapter soft state
1262 * @cmd: Command to be completed
1263 * @alt_status: If non-zero, use this value as status to
1264 * SCSI mid-layer instead of the value returned
1265 * by the FW. This should be used if caller wants
1266 * an alternate status (as in the case of aborted
1270 megasas_complete_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd,
1274 struct megasas_header *hdr = &cmd->frame->hdr;
1277 cmd->scmd->SCp.ptr = NULL;
1281 case MFI_CMD_PD_SCSI_IO:
1282 case MFI_CMD_LD_SCSI_IO:
1285 * MFI_CMD_PD_SCSI_IO and MFI_CMD_LD_SCSI_IO could have been
1286 * issued either through an IO path or an IOCTL path. If it
1287 * was via IOCTL, we will send it to internal completion.
1289 if (cmd->sync_cmd) {
1291 megasas_complete_int_cmd(instance, cmd);
1295 case MFI_CMD_LD_READ:
1296 case MFI_CMD_LD_WRITE:
1299 cmd->scmd->result = alt_status << 16;
1305 atomic_dec(&instance->fw_outstanding);
1307 scsi_dma_unmap(cmd->scmd);
1308 cmd->scmd->scsi_done(cmd->scmd);
1309 megasas_return_cmd(instance, cmd);
1314 switch (hdr->cmd_status) {
1317 cmd->scmd->result = DID_OK << 16;
1320 case MFI_STAT_SCSI_IO_FAILED:
1321 case MFI_STAT_LD_INIT_IN_PROGRESS:
1323 (DID_ERROR << 16) | hdr->scsi_status;
1326 case MFI_STAT_SCSI_DONE_WITH_ERROR:
1328 cmd->scmd->result = (DID_OK << 16) | hdr->scsi_status;
1330 if (hdr->scsi_status == SAM_STAT_CHECK_CONDITION) {
1331 memset(cmd->scmd->sense_buffer, 0,
1332 SCSI_SENSE_BUFFERSIZE);
1333 memcpy(cmd->scmd->sense_buffer, cmd->sense,
1336 cmd->scmd->result |= DRIVER_SENSE << 24;
1341 case MFI_STAT_LD_OFFLINE:
1342 case MFI_STAT_DEVICE_NOT_FOUND:
1343 cmd->scmd->result = DID_BAD_TARGET << 16;
1347 printk(KERN_DEBUG "megasas: MFI FW status %#x\n",
1349 cmd->scmd->result = DID_ERROR << 16;
1353 atomic_dec(&instance->fw_outstanding);
1355 scsi_dma_unmap(cmd->scmd);
1356 cmd->scmd->scsi_done(cmd->scmd);
1357 megasas_return_cmd(instance, cmd);
1366 * See if got an event notification
1368 if (cmd->frame->dcmd.opcode == MR_DCMD_CTRL_EVENT_WAIT)
1369 megasas_service_aen(instance, cmd);
1371 megasas_complete_int_cmd(instance, cmd);
1377 * Cmd issued to abort another cmd returned
1379 megasas_complete_abort(instance, cmd);
1383 printk("megasas: Unknown command completed! [0x%X]\n",
1390 * megasas_deplete_reply_queue - Processes all completed commands
1391 * @instance: Adapter soft state
1392 * @alt_status: Alternate status to be returned to
1393 * SCSI mid-layer instead of the status
1394 * returned by the FW
1397 megasas_deplete_reply_queue(struct megasas_instance *instance, u8 alt_status)
1400 * Check if it is our interrupt
1401 * Clear the interrupt
1403 if(instance->instancet->clear_intr(instance->reg_set))
1406 if (instance->hw_crit_error)
1409 * Schedule the tasklet for cmd completion
1411 tasklet_schedule(&instance->isr_tasklet);
1417 * megasas_isr - isr entry point
1419 static irqreturn_t megasas_isr(int irq, void *devp)
1421 return megasas_deplete_reply_queue((struct megasas_instance *)devp,
1426 * megasas_transition_to_ready - Move the FW to READY state
1427 * @instance: Adapter soft state
1429 * During the initialization, FW passes can potentially be in any one of
1430 * several possible states. If the FW in operational, waiting-for-handshake
1431 * states, driver must take steps to bring it to ready state. Otherwise, it
1432 * has to wait for the ready state.
1435 megasas_transition_to_ready(struct megasas_instance* instance)
1442 fw_state = instance->instancet->read_fw_status_reg(instance->reg_set) & MFI_STATE_MASK;
1444 if (fw_state != MFI_STATE_READY)
1445 printk(KERN_INFO "megasas: Waiting for FW to come to ready"
1448 while (fw_state != MFI_STATE_READY) {
1452 case MFI_STATE_FAULT:
1454 printk(KERN_DEBUG "megasas: FW in FAULT state!!\n");
1457 case MFI_STATE_WAIT_HANDSHAKE:
1459 * Set the CLR bit in inbound doorbell
1461 writel(MFI_INIT_CLEAR_HANDSHAKE|MFI_INIT_HOTPLUG,
1462 &instance->reg_set->inbound_doorbell);
1465 cur_state = MFI_STATE_WAIT_HANDSHAKE;
1468 case MFI_STATE_BOOT_MESSAGE_PENDING:
1469 writel(MFI_INIT_HOTPLUG,
1470 &instance->reg_set->inbound_doorbell);
1473 cur_state = MFI_STATE_BOOT_MESSAGE_PENDING;
1476 case MFI_STATE_OPERATIONAL:
1478 * Bring it to READY state; assuming max wait 10 secs
1480 instance->instancet->disable_intr(instance->reg_set);
1481 writel(MFI_RESET_FLAGS, &instance->reg_set->inbound_doorbell);
1484 cur_state = MFI_STATE_OPERATIONAL;
1487 case MFI_STATE_UNDEFINED:
1489 * This state should not last for more than 2 seconds
1492 cur_state = MFI_STATE_UNDEFINED;
1495 case MFI_STATE_BB_INIT:
1497 cur_state = MFI_STATE_BB_INIT;
1500 case MFI_STATE_FW_INIT:
1502 cur_state = MFI_STATE_FW_INIT;
1505 case MFI_STATE_FW_INIT_2:
1507 cur_state = MFI_STATE_FW_INIT_2;
1510 case MFI_STATE_DEVICE_SCAN:
1512 cur_state = MFI_STATE_DEVICE_SCAN;
1515 case MFI_STATE_FLUSH_CACHE:
1517 cur_state = MFI_STATE_FLUSH_CACHE;
1521 printk(KERN_DEBUG "megasas: Unknown state 0x%x\n",
1527 * The cur_state should not last for more than max_wait secs
1529 for (i = 0; i < (max_wait * 1000); i++) {
1530 fw_state = instance->instancet->read_fw_status_reg(instance->reg_set) &
1533 if (fw_state == cur_state) {
1540 * Return error if fw_state hasn't changed after max_wait
1542 if (fw_state == cur_state) {
1543 printk(KERN_DEBUG "FW state [%d] hasn't changed "
1544 "in %d secs\n", fw_state, max_wait);
1548 printk(KERN_INFO "megasas: FW now in Ready state\n");
1554 * megasas_teardown_frame_pool - Destroy the cmd frame DMA pool
1555 * @instance: Adapter soft state
1557 static void megasas_teardown_frame_pool(struct megasas_instance *instance)
1560 u32 max_cmd = instance->max_fw_cmds;
1561 struct megasas_cmd *cmd;
1563 if (!instance->frame_dma_pool)
1567 * Return all frames to pool
1569 for (i = 0; i < max_cmd; i++) {
1571 cmd = instance->cmd_list[i];
1574 pci_pool_free(instance->frame_dma_pool, cmd->frame,
1575 cmd->frame_phys_addr);
1578 pci_pool_free(instance->sense_dma_pool, cmd->sense,
1579 cmd->sense_phys_addr);
1583 * Now destroy the pool itself
1585 pci_pool_destroy(instance->frame_dma_pool);
1586 pci_pool_destroy(instance->sense_dma_pool);
1588 instance->frame_dma_pool = NULL;
1589 instance->sense_dma_pool = NULL;
1593 * megasas_create_frame_pool - Creates DMA pool for cmd frames
1594 * @instance: Adapter soft state
1596 * Each command packet has an embedded DMA memory buffer that is used for
1597 * filling MFI frame and the SG list that immediately follows the frame. This
1598 * function creates those DMA memory buffers for each command packet by using
1599 * PCI pool facility.
1601 static int megasas_create_frame_pool(struct megasas_instance *instance)
1609 struct megasas_cmd *cmd;
1611 max_cmd = instance->max_fw_cmds;
1614 * Size of our frame is 64 bytes for MFI frame, followed by max SG
1615 * elements and finally SCSI_SENSE_BUFFERSIZE bytes for sense buffer
1617 sge_sz = (IS_DMA64) ? sizeof(struct megasas_sge64) :
1618 sizeof(struct megasas_sge32);
1621 * Calculated the number of 64byte frames required for SGL
1623 sgl_sz = sge_sz * instance->max_num_sge;
1624 frame_count = (sgl_sz + MEGAMFI_FRAME_SIZE - 1) / MEGAMFI_FRAME_SIZE;
1627 * We need one extra frame for the MFI command
1631 total_sz = MEGAMFI_FRAME_SIZE * frame_count;
1633 * Use DMA pool facility provided by PCI layer
1635 instance->frame_dma_pool = pci_pool_create("megasas frame pool",
1636 instance->pdev, total_sz, 64,
1639 if (!instance->frame_dma_pool) {
1640 printk(KERN_DEBUG "megasas: failed to setup frame pool\n");
1644 instance->sense_dma_pool = pci_pool_create("megasas sense pool",
1645 instance->pdev, 128, 4, 0);
1647 if (!instance->sense_dma_pool) {
1648 printk(KERN_DEBUG "megasas: failed to setup sense pool\n");
1650 pci_pool_destroy(instance->frame_dma_pool);
1651 instance->frame_dma_pool = NULL;
1657 * Allocate and attach a frame to each of the commands in cmd_list.
1658 * By making cmd->index as the context instead of the &cmd, we can
1659 * always use 32bit context regardless of the architecture
1661 for (i = 0; i < max_cmd; i++) {
1663 cmd = instance->cmd_list[i];
1665 cmd->frame = pci_pool_alloc(instance->frame_dma_pool,
1666 GFP_KERNEL, &cmd->frame_phys_addr);
1668 cmd->sense = pci_pool_alloc(instance->sense_dma_pool,
1669 GFP_KERNEL, &cmd->sense_phys_addr);
1672 * megasas_teardown_frame_pool() takes care of freeing
1673 * whatever has been allocated
1675 if (!cmd->frame || !cmd->sense) {
1676 printk(KERN_DEBUG "megasas: pci_pool_alloc failed \n");
1677 megasas_teardown_frame_pool(instance);
1681 cmd->frame->io.context = cmd->index;
1688 * megasas_free_cmds - Free all the cmds in the free cmd pool
1689 * @instance: Adapter soft state
1691 static void megasas_free_cmds(struct megasas_instance *instance)
1694 /* First free the MFI frame pool */
1695 megasas_teardown_frame_pool(instance);
1697 /* Free all the commands in the cmd_list */
1698 for (i = 0; i < instance->max_fw_cmds; i++)
1699 kfree(instance->cmd_list[i]);
1701 /* Free the cmd_list buffer itself */
1702 kfree(instance->cmd_list);
1703 instance->cmd_list = NULL;
1705 INIT_LIST_HEAD(&instance->cmd_pool);
1709 * megasas_alloc_cmds - Allocates the command packets
1710 * @instance: Adapter soft state
1712 * Each command that is issued to the FW, whether IO commands from the OS or
1713 * internal commands like IOCTLs, are wrapped in local data structure called
1714 * megasas_cmd. The frame embedded in this megasas_cmd is actually issued to
1717 * Each frame has a 32-bit field called context (tag). This context is used
1718 * to get back the megasas_cmd from the frame when a frame gets completed in
1719 * the ISR. Typically the address of the megasas_cmd itself would be used as
1720 * the context. But we wanted to keep the differences between 32 and 64 bit
1721 * systems to the mininum. We always use 32 bit integers for the context. In
1722 * this driver, the 32 bit values are the indices into an array cmd_list.
1723 * This array is used only to look up the megasas_cmd given the context. The
1724 * free commands themselves are maintained in a linked list called cmd_pool.
1726 static int megasas_alloc_cmds(struct megasas_instance *instance)
1731 struct megasas_cmd *cmd;
1733 max_cmd = instance->max_fw_cmds;
1736 * instance->cmd_list is an array of struct megasas_cmd pointers.
1737 * Allocate the dynamic array first and then allocate individual
1740 instance->cmd_list = kcalloc(max_cmd, sizeof(struct megasas_cmd*), GFP_KERNEL);
1742 if (!instance->cmd_list) {
1743 printk(KERN_DEBUG "megasas: out of memory\n");
1748 for (i = 0; i < max_cmd; i++) {
1749 instance->cmd_list[i] = kmalloc(sizeof(struct megasas_cmd),
1752 if (!instance->cmd_list[i]) {
1754 for (j = 0; j < i; j++)
1755 kfree(instance->cmd_list[j]);
1757 kfree(instance->cmd_list);
1758 instance->cmd_list = NULL;
1765 * Add all the commands to command pool (instance->cmd_pool)
1767 for (i = 0; i < max_cmd; i++) {
1768 cmd = instance->cmd_list[i];
1769 memset(cmd, 0, sizeof(struct megasas_cmd));
1771 cmd->instance = instance;
1773 list_add_tail(&cmd->list, &instance->cmd_pool);
1777 * Create a frame pool and assign one frame to each cmd
1779 if (megasas_create_frame_pool(instance)) {
1780 printk(KERN_DEBUG "megasas: Error creating frame DMA pool\n");
1781 megasas_free_cmds(instance);
1788 * megasas_get_controller_info - Returns FW's controller structure
1789 * @instance: Adapter soft state
1790 * @ctrl_info: Controller information structure
1792 * Issues an internal command (DCMD) to get the FW's controller structure.
1793 * This information is mainly used to find out the maximum IO transfer per
1794 * command supported by the FW.
1797 megasas_get_ctrl_info(struct megasas_instance *instance,
1798 struct megasas_ctrl_info *ctrl_info)
1801 struct megasas_cmd *cmd;
1802 struct megasas_dcmd_frame *dcmd;
1803 struct megasas_ctrl_info *ci;
1804 dma_addr_t ci_h = 0;
1806 cmd = megasas_get_cmd(instance);
1809 printk(KERN_DEBUG "megasas: Failed to get a free cmd\n");
1813 dcmd = &cmd->frame->dcmd;
1815 ci = pci_alloc_consistent(instance->pdev,
1816 sizeof(struct megasas_ctrl_info), &ci_h);
1819 printk(KERN_DEBUG "Failed to alloc mem for ctrl info\n");
1820 megasas_return_cmd(instance, cmd);
1824 memset(ci, 0, sizeof(*ci));
1825 memset(dcmd->mbox.b, 0, MFI_MBOX_SIZE);
1827 dcmd->cmd = MFI_CMD_DCMD;
1828 dcmd->cmd_status = 0xFF;
1829 dcmd->sge_count = 1;
1830 dcmd->flags = MFI_FRAME_DIR_READ;
1832 dcmd->data_xfer_len = sizeof(struct megasas_ctrl_info);
1833 dcmd->opcode = MR_DCMD_CTRL_GET_INFO;
1834 dcmd->sgl.sge32[0].phys_addr = ci_h;
1835 dcmd->sgl.sge32[0].length = sizeof(struct megasas_ctrl_info);
1837 if (!megasas_issue_polled(instance, cmd)) {
1839 memcpy(ctrl_info, ci, sizeof(struct megasas_ctrl_info));
1844 pci_free_consistent(instance->pdev, sizeof(struct megasas_ctrl_info),
1847 megasas_return_cmd(instance, cmd);
1852 * megasas_issue_init_mfi - Initializes the FW
1853 * @instance: Adapter soft state
1855 * Issues the INIT MFI cmd
1858 megasas_issue_init_mfi(struct megasas_instance *instance)
1862 struct megasas_cmd *cmd;
1864 struct megasas_init_frame *init_frame;
1865 struct megasas_init_queue_info *initq_info;
1866 dma_addr_t init_frame_h;
1867 dma_addr_t initq_info_h;
1870 * Prepare a init frame. Note the init frame points to queue info
1871 * structure. Each frame has SGL allocated after first 64 bytes. For
1872 * this frame - since we don't need any SGL - we use SGL's space as
1873 * queue info structure
1875 * We will not get a NULL command below. We just created the pool.
1877 cmd = megasas_get_cmd(instance);
1879 init_frame = (struct megasas_init_frame *)cmd->frame;
1880 initq_info = (struct megasas_init_queue_info *)
1881 ((unsigned long)init_frame + 64);
1883 init_frame_h = cmd->frame_phys_addr;
1884 initq_info_h = init_frame_h + 64;
1886 context = init_frame->context;
1887 memset(init_frame, 0, MEGAMFI_FRAME_SIZE);
1888 memset(initq_info, 0, sizeof(struct megasas_init_queue_info));
1889 init_frame->context = context;
1891 initq_info->reply_queue_entries = instance->max_fw_cmds + 1;
1892 initq_info->reply_queue_start_phys_addr_lo = instance->reply_queue_h;
1894 initq_info->producer_index_phys_addr_lo = instance->producer_h;
1895 initq_info->consumer_index_phys_addr_lo = instance->consumer_h;
1897 init_frame->cmd = MFI_CMD_INIT;
1898 init_frame->cmd_status = 0xFF;
1899 init_frame->queue_info_new_phys_addr_lo = initq_info_h;
1901 init_frame->data_xfer_len = sizeof(struct megasas_init_queue_info);
1904 * disable the intr before firing the init frame to FW
1906 instance->instancet->disable_intr(instance->reg_set);
1909 * Issue the init frame in polled mode
1912 if (megasas_issue_polled(instance, cmd)) {
1913 printk(KERN_ERR "megasas: Failed to init firmware\n");
1914 megasas_return_cmd(instance, cmd);
1918 megasas_return_cmd(instance, cmd);
1927 * megasas_start_timer - Initializes a timer object
1928 * @instance: Adapter soft state
1929 * @timer: timer object to be initialized
1930 * @fn: timer function
1931 * @interval: time interval between timer function call
1934 megasas_start_timer(struct megasas_instance *instance,
1935 struct timer_list *timer,
1936 void *fn, unsigned long interval)
1939 timer->expires = jiffies + interval;
1940 timer->data = (unsigned long)instance;
1941 timer->function = fn;
1946 * megasas_io_completion_timer - Timer fn
1947 * @instance_addr: Address of adapter soft state
1949 * Schedules tasklet for cmd completion
1950 * if poll_mode_io is set
1953 megasas_io_completion_timer(unsigned long instance_addr)
1955 struct megasas_instance *instance =
1956 (struct megasas_instance *)instance_addr;
1958 if (atomic_read(&instance->fw_outstanding))
1959 tasklet_schedule(&instance->isr_tasklet);
1963 mod_timer(&instance->io_completion_timer,
1964 jiffies + MEGASAS_COMPLETION_TIMER_INTERVAL);
1968 * megasas_init_mfi - Initializes the FW
1969 * @instance: Adapter soft state
1971 * This is the main function for initializing MFI firmware.
1973 static int megasas_init_mfi(struct megasas_instance *instance)
1980 struct megasas_register_set __iomem *reg_set;
1981 struct megasas_ctrl_info *ctrl_info;
1983 * Map the message registers
1985 instance->base_addr = pci_resource_start(instance->pdev, 0);
1987 if (pci_request_regions(instance->pdev, "megasas: LSI")) {
1988 printk(KERN_DEBUG "megasas: IO memory region busy!\n");
1992 instance->reg_set = ioremap_nocache(instance->base_addr, 8192);
1994 if (!instance->reg_set) {
1995 printk(KERN_DEBUG "megasas: Failed to map IO mem\n");
1999 reg_set = instance->reg_set;
2001 switch(instance->pdev->device)
2003 case PCI_DEVICE_ID_LSI_SAS1078R:
2004 case PCI_DEVICE_ID_LSI_SAS1078DE:
2005 instance->instancet = &megasas_instance_template_ppc;
2007 case PCI_DEVICE_ID_LSI_SAS1064R:
2008 case PCI_DEVICE_ID_DELL_PERC5:
2010 instance->instancet = &megasas_instance_template_xscale;
2015 * We expect the FW state to be READY
2017 if (megasas_transition_to_ready(instance))
2018 goto fail_ready_state;
2021 * Get various operational parameters from status register
2023 instance->max_fw_cmds = instance->instancet->read_fw_status_reg(reg_set) & 0x00FFFF;
2025 * Reduce the max supported cmds by 1. This is to ensure that the
2026 * reply_q_sz (1 more than the max cmd that driver may send)
2027 * does not exceed max cmds that the FW can support
2029 instance->max_fw_cmds = instance->max_fw_cmds-1;
2030 instance->max_num_sge = (instance->instancet->read_fw_status_reg(reg_set) & 0xFF0000) >>
2033 * Create a pool of commands
2035 if (megasas_alloc_cmds(instance))
2036 goto fail_alloc_cmds;
2039 * Allocate memory for reply queue. Length of reply queue should
2040 * be _one_ more than the maximum commands handled by the firmware.
2042 * Note: When FW completes commands, it places corresponding contex
2043 * values in this circular reply queue. This circular queue is a fairly
2044 * typical producer-consumer queue. FW is the producer (of completed
2045 * commands) and the driver is the consumer.
2047 context_sz = sizeof(u32);
2048 reply_q_sz = context_sz * (instance->max_fw_cmds + 1);
2050 instance->reply_queue = pci_alloc_consistent(instance->pdev,
2052 &instance->reply_queue_h);
2054 if (!instance->reply_queue) {
2055 printk(KERN_DEBUG "megasas: Out of DMA mem for reply queue\n");
2056 goto fail_reply_queue;
2059 if (megasas_issue_init_mfi(instance))
2062 ctrl_info = kmalloc(sizeof(struct megasas_ctrl_info), GFP_KERNEL);
2065 * Compute the max allowed sectors per IO: The controller info has two
2066 * limits on max sectors. Driver should use the minimum of these two.
2068 * 1 << stripe_sz_ops.min = max sectors per strip
2070 * Note that older firmwares ( < FW ver 30) didn't report information
2071 * to calculate max_sectors_1. So the number ended up as zero always.
2074 if (ctrl_info && !megasas_get_ctrl_info(instance, ctrl_info)) {
2076 max_sectors_1 = (1 << ctrl_info->stripe_sz_ops.min) *
2077 ctrl_info->max_strips_per_io;
2078 max_sectors_2 = ctrl_info->max_request_size;
2080 tmp_sectors = min_t(u32, max_sectors_1 , max_sectors_2);
2083 instance->max_sectors_per_req = instance->max_num_sge *
2085 if (tmp_sectors && (instance->max_sectors_per_req > tmp_sectors))
2086 instance->max_sectors_per_req = tmp_sectors;
2091 * Setup tasklet for cmd completion
2094 tasklet_init(&instance->isr_tasklet, megasas_complete_cmd_dpc,
2095 (unsigned long)instance);
2097 /* Initialize the cmd completion timer */
2099 megasas_start_timer(instance, &instance->io_completion_timer,
2100 megasas_io_completion_timer,
2101 MEGASAS_COMPLETION_TIMER_INTERVAL);
2106 pci_free_consistent(instance->pdev, reply_q_sz,
2107 instance->reply_queue, instance->reply_queue_h);
2109 megasas_free_cmds(instance);
2113 iounmap(instance->reg_set);
2116 pci_release_regions(instance->pdev);
2122 * megasas_release_mfi - Reverses the FW initialization
2123 * @intance: Adapter soft state
2125 static void megasas_release_mfi(struct megasas_instance *instance)
2127 u32 reply_q_sz = sizeof(u32) * (instance->max_fw_cmds + 1);
2129 pci_free_consistent(instance->pdev, reply_q_sz,
2130 instance->reply_queue, instance->reply_queue_h);
2132 megasas_free_cmds(instance);
2134 iounmap(instance->reg_set);
2136 pci_release_regions(instance->pdev);
2140 * megasas_get_seq_num - Gets latest event sequence numbers
2141 * @instance: Adapter soft state
2142 * @eli: FW event log sequence numbers information
2144 * FW maintains a log of all events in a non-volatile area. Upper layers would
2145 * usually find out the latest sequence number of the events, the seq number at
2146 * the boot etc. They would "read" all the events below the latest seq number
2147 * by issuing a direct fw cmd (DCMD). For the future events (beyond latest seq
2148 * number), they would subsribe to AEN (asynchronous event notification) and
2149 * wait for the events to happen.
2152 megasas_get_seq_num(struct megasas_instance *instance,
2153 struct megasas_evt_log_info *eli)
2155 struct megasas_cmd *cmd;
2156 struct megasas_dcmd_frame *dcmd;
2157 struct megasas_evt_log_info *el_info;
2158 dma_addr_t el_info_h = 0;
2160 cmd = megasas_get_cmd(instance);
2166 dcmd = &cmd->frame->dcmd;
2167 el_info = pci_alloc_consistent(instance->pdev,
2168 sizeof(struct megasas_evt_log_info),
2172 megasas_return_cmd(instance, cmd);
2176 memset(el_info, 0, sizeof(*el_info));
2177 memset(dcmd->mbox.b, 0, MFI_MBOX_SIZE);
2179 dcmd->cmd = MFI_CMD_DCMD;
2180 dcmd->cmd_status = 0x0;
2181 dcmd->sge_count = 1;
2182 dcmd->flags = MFI_FRAME_DIR_READ;
2184 dcmd->data_xfer_len = sizeof(struct megasas_evt_log_info);
2185 dcmd->opcode = MR_DCMD_CTRL_EVENT_GET_INFO;
2186 dcmd->sgl.sge32[0].phys_addr = el_info_h;
2187 dcmd->sgl.sge32[0].length = sizeof(struct megasas_evt_log_info);
2189 megasas_issue_blocked_cmd(instance, cmd);
2192 * Copy the data back into callers buffer
2194 memcpy(eli, el_info, sizeof(struct megasas_evt_log_info));
2196 pci_free_consistent(instance->pdev, sizeof(struct megasas_evt_log_info),
2197 el_info, el_info_h);
2199 megasas_return_cmd(instance, cmd);
2205 * megasas_register_aen - Registers for asynchronous event notification
2206 * @instance: Adapter soft state
2207 * @seq_num: The starting sequence number
2208 * @class_locale: Class of the event
2210 * This function subscribes for AEN for events beyond the @seq_num. It requests
2211 * to be notified if and only if the event is of type @class_locale
2214 megasas_register_aen(struct megasas_instance *instance, u32 seq_num,
2215 u32 class_locale_word)
2218 struct megasas_cmd *cmd;
2219 struct megasas_dcmd_frame *dcmd;
2220 union megasas_evt_class_locale curr_aen;
2221 union megasas_evt_class_locale prev_aen;
2224 * If there an AEN pending already (aen_cmd), check if the
2225 * class_locale of that pending AEN is inclusive of the new
2226 * AEN request we currently have. If it is, then we don't have
2227 * to do anything. In other words, whichever events the current
2228 * AEN request is subscribing to, have already been subscribed
2231 * If the old_cmd is _not_ inclusive, then we have to abort
2232 * that command, form a class_locale that is superset of both
2233 * old and current and re-issue to the FW
2236 curr_aen.word = class_locale_word;
2238 if (instance->aen_cmd) {
2240 prev_aen.word = instance->aen_cmd->frame->dcmd.mbox.w[1];
2243 * A class whose enum value is smaller is inclusive of all
2244 * higher values. If a PROGRESS (= -1) was previously
2245 * registered, then a new registration requests for higher
2246 * classes need not be sent to FW. They are automatically
2249 * Locale numbers don't have such hierarchy. They are bitmap
2252 if ((prev_aen.members.class <= curr_aen.members.class) &&
2253 !((prev_aen.members.locale & curr_aen.members.locale) ^
2254 curr_aen.members.locale)) {
2256 * Previously issued event registration includes
2257 * current request. Nothing to do.
2261 curr_aen.members.locale |= prev_aen.members.locale;
2263 if (prev_aen.members.class < curr_aen.members.class)
2264 curr_aen.members.class = prev_aen.members.class;
2266 instance->aen_cmd->abort_aen = 1;
2267 ret_val = megasas_issue_blocked_abort_cmd(instance,
2272 printk(KERN_DEBUG "megasas: Failed to abort "
2273 "previous AEN command\n");
2279 cmd = megasas_get_cmd(instance);
2284 dcmd = &cmd->frame->dcmd;
2286 memset(instance->evt_detail, 0, sizeof(struct megasas_evt_detail));
2289 * Prepare DCMD for aen registration
2291 memset(dcmd->mbox.b, 0, MFI_MBOX_SIZE);
2293 dcmd->cmd = MFI_CMD_DCMD;
2294 dcmd->cmd_status = 0x0;
2295 dcmd->sge_count = 1;
2296 dcmd->flags = MFI_FRAME_DIR_READ;
2298 dcmd->data_xfer_len = sizeof(struct megasas_evt_detail);
2299 dcmd->opcode = MR_DCMD_CTRL_EVENT_WAIT;
2300 dcmd->mbox.w[0] = seq_num;
2301 dcmd->mbox.w[1] = curr_aen.word;
2302 dcmd->sgl.sge32[0].phys_addr = (u32) instance->evt_detail_h;
2303 dcmd->sgl.sge32[0].length = sizeof(struct megasas_evt_detail);
2306 * Store reference to the cmd used to register for AEN. When an
2307 * application wants us to register for AEN, we have to abort this
2308 * cmd and re-register with a new EVENT LOCALE supplied by that app
2310 instance->aen_cmd = cmd;
2313 * Issue the aen registration frame
2315 instance->instancet->fire_cmd(cmd->frame_phys_addr ,0,instance->reg_set);
2321 * megasas_start_aen - Subscribes to AEN during driver load time
2322 * @instance: Adapter soft state
2324 static int megasas_start_aen(struct megasas_instance *instance)
2326 struct megasas_evt_log_info eli;
2327 union megasas_evt_class_locale class_locale;
2330 * Get the latest sequence number from FW
2332 memset(&eli, 0, sizeof(eli));
2334 if (megasas_get_seq_num(instance, &eli))
2338 * Register AEN with FW for latest sequence number plus 1
2340 class_locale.members.reserved = 0;
2341 class_locale.members.locale = MR_EVT_LOCALE_ALL;
2342 class_locale.members.class = MR_EVT_CLASS_DEBUG;
2344 return megasas_register_aen(instance, eli.newest_seq_num + 1,
2349 * megasas_io_attach - Attaches this driver to SCSI mid-layer
2350 * @instance: Adapter soft state
2352 static int megasas_io_attach(struct megasas_instance *instance)
2354 struct Scsi_Host *host = instance->host;
2357 * Export parameters required by SCSI mid-layer
2359 host->irq = instance->pdev->irq;
2360 host->unique_id = instance->unique_id;
2361 host->can_queue = instance->max_fw_cmds - MEGASAS_INT_CMDS;
2362 host->this_id = instance->init_id;
2363 host->sg_tablesize = instance->max_num_sge;
2364 host->max_sectors = instance->max_sectors_per_req;
2365 host->cmd_per_lun = 128;
2366 host->max_channel = MEGASAS_MAX_CHANNELS - 1;
2367 host->max_id = MEGASAS_MAX_DEV_PER_CHANNEL;
2368 host->max_lun = MEGASAS_MAX_LUN;
2369 host->max_cmd_len = 16;
2372 * Notify the mid-layer about the new controller
2374 if (scsi_add_host(host, &instance->pdev->dev)) {
2375 printk(KERN_DEBUG "megasas: scsi_add_host failed\n");
2380 * Trigger SCSI to scan our drives
2382 scsi_scan_host(host);
2387 megasas_set_dma_mask(struct pci_dev *pdev)
2390 * All our contollers are capable of performing 64-bit DMA
2393 if (pci_set_dma_mask(pdev, DMA_64BIT_MASK) != 0) {
2395 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK) != 0)
2396 goto fail_set_dma_mask;
2399 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK) != 0)
2400 goto fail_set_dma_mask;
2409 * megasas_probe_one - PCI hotplug entry point
2410 * @pdev: PCI device structure
2411 * @id: PCI ids of supported hotplugged adapter
2413 static int __devinit
2414 megasas_probe_one(struct pci_dev *pdev, const struct pci_device_id *id)
2417 struct Scsi_Host *host;
2418 struct megasas_instance *instance;
2421 * Announce PCI information
2423 printk(KERN_INFO "megasas: %#4.04x:%#4.04x:%#4.04x:%#4.04x: ",
2424 pdev->vendor, pdev->device, pdev->subsystem_vendor,
2425 pdev->subsystem_device);
2427 printk("bus %d:slot %d:func %d\n",
2428 pdev->bus->number, PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn));
2431 * PCI prepping: enable device set bus mastering and dma mask
2433 rval = pci_enable_device(pdev);
2439 pci_set_master(pdev);
2441 if (megasas_set_dma_mask(pdev))
2442 goto fail_set_dma_mask;
2444 host = scsi_host_alloc(&megasas_template,
2445 sizeof(struct megasas_instance));
2448 printk(KERN_DEBUG "megasas: scsi_host_alloc failed\n");
2449 goto fail_alloc_instance;
2452 instance = (struct megasas_instance *)host->hostdata;
2453 memset(instance, 0, sizeof(*instance));
2455 instance->producer = pci_alloc_consistent(pdev, sizeof(u32),
2456 &instance->producer_h);
2457 instance->consumer = pci_alloc_consistent(pdev, sizeof(u32),
2458 &instance->consumer_h);
2460 if (!instance->producer || !instance->consumer) {
2461 printk(KERN_DEBUG "megasas: Failed to allocate memory for "
2462 "producer, consumer\n");
2463 goto fail_alloc_dma_buf;
2466 *instance->producer = 0;
2467 *instance->consumer = 0;
2469 instance->evt_detail = pci_alloc_consistent(pdev,
2471 megasas_evt_detail),
2472 &instance->evt_detail_h);
2474 if (!instance->evt_detail) {
2475 printk(KERN_DEBUG "megasas: Failed to allocate memory for "
2476 "event detail structure\n");
2477 goto fail_alloc_dma_buf;
2481 * Initialize locks and queues
2483 INIT_LIST_HEAD(&instance->cmd_pool);
2485 atomic_set(&instance->fw_outstanding,0);
2487 init_waitqueue_head(&instance->int_cmd_wait_q);
2488 init_waitqueue_head(&instance->abort_cmd_wait_q);
2490 spin_lock_init(&instance->cmd_pool_lock);
2491 spin_lock_init(&instance->completion_lock);
2493 mutex_init(&instance->aen_mutex);
2494 sema_init(&instance->ioctl_sem, MEGASAS_INT_CMDS);
2497 * Initialize PCI related and misc parameters
2499 instance->pdev = pdev;
2500 instance->host = host;
2501 instance->unique_id = pdev->bus->number << 8 | pdev->devfn;
2502 instance->init_id = MEGASAS_DEFAULT_INIT_ID;
2504 megasas_dbg_lvl = 0;
2506 instance->last_time = 0;
2509 * Initialize MFI Firmware
2511 if (megasas_init_mfi(instance))
2517 if (request_irq(pdev->irq, megasas_isr, IRQF_SHARED, "megasas", instance)) {
2518 printk(KERN_DEBUG "megasas: Failed to register IRQ\n");
2522 instance->instancet->enable_intr(instance->reg_set);
2525 * Store instance in PCI softstate
2527 pci_set_drvdata(pdev, instance);
2530 * Add this controller to megasas_mgmt_info structure so that it
2531 * can be exported to management applications
2533 megasas_mgmt_info.count++;
2534 megasas_mgmt_info.instance[megasas_mgmt_info.max_index] = instance;
2535 megasas_mgmt_info.max_index++;
2538 * Initiate AEN (Asynchronous Event Notification)
2540 if (megasas_start_aen(instance)) {
2541 printk(KERN_DEBUG "megasas: start aen failed\n");
2542 goto fail_start_aen;
2546 * Register with SCSI mid-layer
2548 if (megasas_io_attach(instance))
2549 goto fail_io_attach;
2555 megasas_mgmt_info.count--;
2556 megasas_mgmt_info.instance[megasas_mgmt_info.max_index] = NULL;
2557 megasas_mgmt_info.max_index--;
2559 pci_set_drvdata(pdev, NULL);
2560 instance->instancet->disable_intr(instance->reg_set);
2561 free_irq(instance->pdev->irq, instance);
2563 megasas_release_mfi(instance);
2568 if (instance->evt_detail)
2569 pci_free_consistent(pdev, sizeof(struct megasas_evt_detail),
2570 instance->evt_detail,
2571 instance->evt_detail_h);
2573 if (instance->producer)
2574 pci_free_consistent(pdev, sizeof(u32), instance->producer,
2575 instance->producer_h);
2576 if (instance->consumer)
2577 pci_free_consistent(pdev, sizeof(u32), instance->consumer,
2578 instance->consumer_h);
2579 scsi_host_put(host);
2581 fail_alloc_instance:
2583 pci_disable_device(pdev);
2589 * megasas_flush_cache - Requests FW to flush all its caches
2590 * @instance: Adapter soft state
2592 static void megasas_flush_cache(struct megasas_instance *instance)
2594 struct megasas_cmd *cmd;
2595 struct megasas_dcmd_frame *dcmd;
2597 cmd = megasas_get_cmd(instance);
2602 dcmd = &cmd->frame->dcmd;
2604 memset(dcmd->mbox.b, 0, MFI_MBOX_SIZE);
2606 dcmd->cmd = MFI_CMD_DCMD;
2607 dcmd->cmd_status = 0x0;
2608 dcmd->sge_count = 0;
2609 dcmd->flags = MFI_FRAME_DIR_NONE;
2611 dcmd->data_xfer_len = 0;
2612 dcmd->opcode = MR_DCMD_CTRL_CACHE_FLUSH;
2613 dcmd->mbox.b[0] = MR_FLUSH_CTRL_CACHE | MR_FLUSH_DISK_CACHE;
2615 megasas_issue_blocked_cmd(instance, cmd);
2617 megasas_return_cmd(instance, cmd);
2623 * megasas_shutdown_controller - Instructs FW to shutdown the controller
2624 * @instance: Adapter soft state
2625 * @opcode: Shutdown/Hibernate
2627 static void megasas_shutdown_controller(struct megasas_instance *instance,
2630 struct megasas_cmd *cmd;
2631 struct megasas_dcmd_frame *dcmd;
2633 cmd = megasas_get_cmd(instance);
2638 if (instance->aen_cmd)
2639 megasas_issue_blocked_abort_cmd(instance, instance->aen_cmd);
2641 dcmd = &cmd->frame->dcmd;
2643 memset(dcmd->mbox.b, 0, MFI_MBOX_SIZE);
2645 dcmd->cmd = MFI_CMD_DCMD;
2646 dcmd->cmd_status = 0x0;
2647 dcmd->sge_count = 0;
2648 dcmd->flags = MFI_FRAME_DIR_NONE;
2650 dcmd->data_xfer_len = 0;
2651 dcmd->opcode = opcode;
2653 megasas_issue_blocked_cmd(instance, cmd);
2655 megasas_return_cmd(instance, cmd);
2662 * megasas_suspend - driver suspend entry point
2663 * @pdev: PCI device structure
2664 * @state: PCI power state to suspend routine
2667 megasas_suspend(struct pci_dev *pdev, pm_message_t state)
2669 struct Scsi_Host *host;
2670 struct megasas_instance *instance;
2672 instance = pci_get_drvdata(pdev);
2673 host = instance->host;
2676 del_timer_sync(&instance->io_completion_timer);
2678 megasas_flush_cache(instance);
2679 megasas_shutdown_controller(instance, MR_DCMD_HIBERNATE_SHUTDOWN);
2680 tasklet_kill(&instance->isr_tasklet);
2682 pci_set_drvdata(instance->pdev, instance);
2683 instance->instancet->disable_intr(instance->reg_set);
2684 free_irq(instance->pdev->irq, instance);
2686 pci_save_state(pdev);
2687 pci_disable_device(pdev);
2689 pci_set_power_state(pdev, pci_choose_state(pdev, state));
2695 * megasas_resume- driver resume entry point
2696 * @pdev: PCI device structure
2699 megasas_resume(struct pci_dev *pdev)
2702 struct Scsi_Host *host;
2703 struct megasas_instance *instance;
2705 instance = pci_get_drvdata(pdev);
2706 host = instance->host;
2707 pci_set_power_state(pdev, PCI_D0);
2708 pci_enable_wake(pdev, PCI_D0, 0);
2709 pci_restore_state(pdev);
2712 * PCI prepping: enable device set bus mastering and dma mask
2714 rval = pci_enable_device(pdev);
2717 printk(KERN_ERR "megasas: Enable device failed\n");
2721 pci_set_master(pdev);
2723 if (megasas_set_dma_mask(pdev))
2724 goto fail_set_dma_mask;
2727 * Initialize MFI Firmware
2730 *instance->producer = 0;
2731 *instance->consumer = 0;
2733 atomic_set(&instance->fw_outstanding, 0);
2736 * We expect the FW state to be READY
2738 if (megasas_transition_to_ready(instance))
2739 goto fail_ready_state;
2741 if (megasas_issue_init_mfi(instance))
2744 tasklet_init(&instance->isr_tasklet, megasas_complete_cmd_dpc,
2745 (unsigned long)instance);
2750 if (request_irq(pdev->irq, megasas_isr, IRQF_SHARED,
2751 "megasas", instance)) {
2752 printk(KERN_ERR "megasas: Failed to register IRQ\n");
2756 instance->instancet->enable_intr(instance->reg_set);
2759 * Initiate AEN (Asynchronous Event Notification)
2761 if (megasas_start_aen(instance))
2762 printk(KERN_ERR "megasas: Start AEN failed\n");
2764 /* Initialize the cmd completion timer */
2766 megasas_start_timer(instance, &instance->io_completion_timer,
2767 megasas_io_completion_timer,
2768 MEGASAS_COMPLETION_TIMER_INTERVAL);
2773 if (instance->evt_detail)
2774 pci_free_consistent(pdev, sizeof(struct megasas_evt_detail),
2775 instance->evt_detail,
2776 instance->evt_detail_h);
2778 if (instance->producer)
2779 pci_free_consistent(pdev, sizeof(u32), instance->producer,
2780 instance->producer_h);
2781 if (instance->consumer)
2782 pci_free_consistent(pdev, sizeof(u32), instance->consumer,
2783 instance->consumer_h);
2784 scsi_host_put(host);
2789 pci_disable_device(pdev);
2794 #define megasas_suspend NULL
2795 #define megasas_resume NULL
2799 * megasas_detach_one - PCI hot"un"plug entry point
2800 * @pdev: PCI device structure
2802 static void __devexit megasas_detach_one(struct pci_dev *pdev)
2805 struct Scsi_Host *host;
2806 struct megasas_instance *instance;
2808 instance = pci_get_drvdata(pdev);
2809 host = instance->host;
2812 del_timer_sync(&instance->io_completion_timer);
2814 scsi_remove_host(instance->host);
2815 megasas_flush_cache(instance);
2816 megasas_shutdown_controller(instance, MR_DCMD_CTRL_SHUTDOWN);
2817 tasklet_kill(&instance->isr_tasklet);
2820 * Take the instance off the instance array. Note that we will not
2821 * decrement the max_index. We let this array be sparse array
2823 for (i = 0; i < megasas_mgmt_info.max_index; i++) {
2824 if (megasas_mgmt_info.instance[i] == instance) {
2825 megasas_mgmt_info.count--;
2826 megasas_mgmt_info.instance[i] = NULL;
2832 pci_set_drvdata(instance->pdev, NULL);
2834 instance->instancet->disable_intr(instance->reg_set);
2836 free_irq(instance->pdev->irq, instance);
2838 megasas_release_mfi(instance);
2840 pci_free_consistent(pdev, sizeof(struct megasas_evt_detail),
2841 instance->evt_detail, instance->evt_detail_h);
2843 pci_free_consistent(pdev, sizeof(u32), instance->producer,
2844 instance->producer_h);
2846 pci_free_consistent(pdev, sizeof(u32), instance->consumer,
2847 instance->consumer_h);
2849 scsi_host_put(host);
2851 pci_set_drvdata(pdev, NULL);
2853 pci_disable_device(pdev);
2859 * megasas_shutdown - Shutdown entry point
2860 * @device: Generic device structure
2862 static void megasas_shutdown(struct pci_dev *pdev)
2864 struct megasas_instance *instance = pci_get_drvdata(pdev);
2865 megasas_flush_cache(instance);
2869 * megasas_mgmt_open - char node "open" entry point
2871 static int megasas_mgmt_open(struct inode *inode, struct file *filep)
2873 cycle_kernel_lock();
2875 * Allow only those users with admin rights
2877 if (!capable(CAP_SYS_ADMIN))
2884 * megasas_mgmt_release - char node "release" entry point
2886 static int megasas_mgmt_release(struct inode *inode, struct file *filep)
2888 filep->private_data = NULL;
2889 fasync_helper(-1, filep, 0, &megasas_async_queue);
2895 * megasas_mgmt_fasync - Async notifier registration from applications
2897 * This function adds the calling process to a driver global queue. When an
2898 * event occurs, SIGIO will be sent to all processes in this queue.
2900 static int megasas_mgmt_fasync(int fd, struct file *filep, int mode)
2904 mutex_lock(&megasas_async_queue_mutex);
2906 rc = fasync_helper(fd, filep, mode, &megasas_async_queue);
2908 mutex_unlock(&megasas_async_queue_mutex);
2911 /* For sanity check when we get ioctl */
2912 filep->private_data = filep;
2916 printk(KERN_DEBUG "megasas: fasync_helper failed [%d]\n", rc);
2922 * megasas_mgmt_fw_ioctl - Issues management ioctls to FW
2923 * @instance: Adapter soft state
2924 * @argp: User's ioctl packet
2927 megasas_mgmt_fw_ioctl(struct megasas_instance *instance,
2928 struct megasas_iocpacket __user * user_ioc,
2929 struct megasas_iocpacket *ioc)
2931 struct megasas_sge32 *kern_sge32;
2932 struct megasas_cmd *cmd;
2933 void *kbuff_arr[MAX_IOCTL_SGE];
2934 dma_addr_t buf_handle = 0;
2937 dma_addr_t sense_handle;
2940 memset(kbuff_arr, 0, sizeof(kbuff_arr));
2942 if (ioc->sge_count > MAX_IOCTL_SGE) {
2943 printk(KERN_DEBUG "megasas: SGE count [%d] > max limit [%d]\n",
2944 ioc->sge_count, MAX_IOCTL_SGE);
2948 cmd = megasas_get_cmd(instance);
2950 printk(KERN_DEBUG "megasas: Failed to get a cmd packet\n");
2955 * User's IOCTL packet has 2 frames (maximum). Copy those two
2956 * frames into our cmd's frames. cmd->frame's context will get
2957 * overwritten when we copy from user's frames. So set that value
2960 memcpy(cmd->frame, ioc->frame.raw, 2 * MEGAMFI_FRAME_SIZE);
2961 cmd->frame->hdr.context = cmd->index;
2964 * The management interface between applications and the fw uses
2965 * MFI frames. E.g, RAID configuration changes, LD property changes
2966 * etc are accomplishes through different kinds of MFI frames. The
2967 * driver needs to care only about substituting user buffers with
2968 * kernel buffers in SGLs. The location of SGL is embedded in the
2969 * struct iocpacket itself.
2971 kern_sge32 = (struct megasas_sge32 *)
2972 ((unsigned long)cmd->frame + ioc->sgl_off);
2975 * For each user buffer, create a mirror buffer and copy in
2977 for (i = 0; i < ioc->sge_count; i++) {
2978 kbuff_arr[i] = dma_alloc_coherent(&instance->pdev->dev,
2979 ioc->sgl[i].iov_len,
2980 &buf_handle, GFP_KERNEL);
2981 if (!kbuff_arr[i]) {
2982 printk(KERN_DEBUG "megasas: Failed to alloc "
2983 "kernel SGL buffer for IOCTL \n");
2989 * We don't change the dma_coherent_mask, so
2990 * pci_alloc_consistent only returns 32bit addresses
2992 kern_sge32[i].phys_addr = (u32) buf_handle;
2993 kern_sge32[i].length = ioc->sgl[i].iov_len;
2996 * We created a kernel buffer corresponding to the
2997 * user buffer. Now copy in from the user buffer
2999 if (copy_from_user(kbuff_arr[i], ioc->sgl[i].iov_base,
3000 (u32) (ioc->sgl[i].iov_len))) {
3006 if (ioc->sense_len) {
3007 sense = dma_alloc_coherent(&instance->pdev->dev, ioc->sense_len,
3008 &sense_handle, GFP_KERNEL);
3015 (u32 *) ((unsigned long)cmd->frame + ioc->sense_off);
3016 *sense_ptr = sense_handle;
3020 * Set the sync_cmd flag so that the ISR knows not to complete this
3021 * cmd to the SCSI mid-layer
3024 megasas_issue_blocked_cmd(instance, cmd);
3028 * copy out the kernel buffers to user buffers
3030 for (i = 0; i < ioc->sge_count; i++) {
3031 if (copy_to_user(ioc->sgl[i].iov_base, kbuff_arr[i],
3032 ioc->sgl[i].iov_len)) {
3039 * copy out the sense
3041 if (ioc->sense_len) {
3043 * sense_ptr points to the location that has the user
3044 * sense buffer address
3046 sense_ptr = (u32 *) ((unsigned long)ioc->frame.raw +
3049 if (copy_to_user((void __user *)((unsigned long)(*sense_ptr)),
3050 sense, ioc->sense_len)) {
3051 printk(KERN_ERR "megasas: Failed to copy out to user "
3059 * copy the status codes returned by the fw
3061 if (copy_to_user(&user_ioc->frame.hdr.cmd_status,
3062 &cmd->frame->hdr.cmd_status, sizeof(u8))) {
3063 printk(KERN_DEBUG "megasas: Error copying out cmd_status\n");
3069 dma_free_coherent(&instance->pdev->dev, ioc->sense_len,
3070 sense, sense_handle);
3073 for (i = 0; i < ioc->sge_count && kbuff_arr[i]; i++) {
3074 dma_free_coherent(&instance->pdev->dev,
3075 kern_sge32[i].length,
3076 kbuff_arr[i], kern_sge32[i].phys_addr);
3079 megasas_return_cmd(instance, cmd);
3083 static struct megasas_instance *megasas_lookup_instance(u16 host_no)
3087 for (i = 0; i < megasas_mgmt_info.max_index; i++) {
3089 if ((megasas_mgmt_info.instance[i]) &&
3090 (megasas_mgmt_info.instance[i]->host->host_no == host_no))
3091 return megasas_mgmt_info.instance[i];
3097 static int megasas_mgmt_ioctl_fw(struct file *file, unsigned long arg)
3099 struct megasas_iocpacket __user *user_ioc =
3100 (struct megasas_iocpacket __user *)arg;
3101 struct megasas_iocpacket *ioc;
3102 struct megasas_instance *instance;
3105 ioc = kmalloc(sizeof(*ioc), GFP_KERNEL);
3109 if (copy_from_user(ioc, user_ioc, sizeof(*ioc))) {
3114 instance = megasas_lookup_instance(ioc->host_no);
3121 * We will allow only MEGASAS_INT_CMDS number of parallel ioctl cmds
3123 if (down_interruptible(&instance->ioctl_sem)) {
3124 error = -ERESTARTSYS;
3127 error = megasas_mgmt_fw_ioctl(instance, user_ioc, ioc);
3128 up(&instance->ioctl_sem);
3135 static int megasas_mgmt_ioctl_aen(struct file *file, unsigned long arg)
3137 struct megasas_instance *instance;
3138 struct megasas_aen aen;
3141 if (file->private_data != file) {
3142 printk(KERN_DEBUG "megasas: fasync_helper was not "
3147 if (copy_from_user(&aen, (void __user *)arg, sizeof(aen)))
3150 instance = megasas_lookup_instance(aen.host_no);
3155 mutex_lock(&instance->aen_mutex);
3156 error = megasas_register_aen(instance, aen.seq_num,
3157 aen.class_locale_word);
3158 mutex_unlock(&instance->aen_mutex);
3163 * megasas_mgmt_ioctl - char node ioctl entry point
3166 megasas_mgmt_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3169 case MEGASAS_IOC_FIRMWARE:
3170 return megasas_mgmt_ioctl_fw(file, arg);
3172 case MEGASAS_IOC_GET_AEN:
3173 return megasas_mgmt_ioctl_aen(file, arg);
3179 #ifdef CONFIG_COMPAT
3180 static int megasas_mgmt_compat_ioctl_fw(struct file *file, unsigned long arg)
3182 struct compat_megasas_iocpacket __user *cioc =
3183 (struct compat_megasas_iocpacket __user *)arg;
3184 struct megasas_iocpacket __user *ioc =
3185 compat_alloc_user_space(sizeof(struct megasas_iocpacket));
3189 if (clear_user(ioc, sizeof(*ioc)))
3192 if (copy_in_user(&ioc->host_no, &cioc->host_no, sizeof(u16)) ||
3193 copy_in_user(&ioc->sgl_off, &cioc->sgl_off, sizeof(u32)) ||
3194 copy_in_user(&ioc->sense_off, &cioc->sense_off, sizeof(u32)) ||
3195 copy_in_user(&ioc->sense_len, &cioc->sense_len, sizeof(u32)) ||
3196 copy_in_user(ioc->frame.raw, cioc->frame.raw, 128) ||
3197 copy_in_user(&ioc->sge_count, &cioc->sge_count, sizeof(u32)))
3200 for (i = 0; i < MAX_IOCTL_SGE; i++) {
3203 if (get_user(ptr, &cioc->sgl[i].iov_base) ||
3204 put_user(compat_ptr(ptr), &ioc->sgl[i].iov_base) ||
3205 copy_in_user(&ioc->sgl[i].iov_len,
3206 &cioc->sgl[i].iov_len, sizeof(compat_size_t)))
3210 error = megasas_mgmt_ioctl_fw(file, (unsigned long)ioc);
3212 if (copy_in_user(&cioc->frame.hdr.cmd_status,
3213 &ioc->frame.hdr.cmd_status, sizeof(u8))) {
3214 printk(KERN_DEBUG "megasas: error copy_in_user cmd_status\n");
3221 megasas_mgmt_compat_ioctl(struct file *file, unsigned int cmd,
3225 case MEGASAS_IOC_FIRMWARE32:
3226 return megasas_mgmt_compat_ioctl_fw(file, arg);
3227 case MEGASAS_IOC_GET_AEN:
3228 return megasas_mgmt_ioctl_aen(file, arg);
3236 * File operations structure for management interface
3238 static const struct file_operations megasas_mgmt_fops = {
3239 .owner = THIS_MODULE,
3240 .open = megasas_mgmt_open,
3241 .release = megasas_mgmt_release,
3242 .fasync = megasas_mgmt_fasync,
3243 .unlocked_ioctl = megasas_mgmt_ioctl,
3244 #ifdef CONFIG_COMPAT
3245 .compat_ioctl = megasas_mgmt_compat_ioctl,
3250 * PCI hotplug support registration structure
3252 static struct pci_driver megasas_pci_driver = {
3254 .name = "megaraid_sas",
3255 .id_table = megasas_pci_table,
3256 .probe = megasas_probe_one,
3257 .remove = __devexit_p(megasas_detach_one),
3258 .suspend = megasas_suspend,
3259 .resume = megasas_resume,
3260 .shutdown = megasas_shutdown,
3264 * Sysfs driver attributes
3266 static ssize_t megasas_sysfs_show_version(struct device_driver *dd, char *buf)
3268 return snprintf(buf, strlen(MEGASAS_VERSION) + 2, "%s\n",
3272 static DRIVER_ATTR(version, S_IRUGO, megasas_sysfs_show_version, NULL);
3275 megasas_sysfs_show_release_date(struct device_driver *dd, char *buf)
3277 return snprintf(buf, strlen(MEGASAS_RELDATE) + 2, "%s\n",
3281 static DRIVER_ATTR(release_date, S_IRUGO, megasas_sysfs_show_release_date,
3285 megasas_sysfs_show_dbg_lvl(struct device_driver *dd, char *buf)
3287 return sprintf(buf, "%u\n", megasas_dbg_lvl);
3291 megasas_sysfs_set_dbg_lvl(struct device_driver *dd, const char *buf, size_t count)
3294 if(sscanf(buf,"%u",&megasas_dbg_lvl)<1){
3295 printk(KERN_ERR "megasas: could not set dbg_lvl\n");
3301 static DRIVER_ATTR(dbg_lvl, S_IRUGO|S_IWUGO, megasas_sysfs_show_dbg_lvl,
3302 megasas_sysfs_set_dbg_lvl);
3305 megasas_sysfs_show_poll_mode_io(struct device_driver *dd, char *buf)
3307 return sprintf(buf, "%u\n", poll_mode_io);
3311 megasas_sysfs_set_poll_mode_io(struct device_driver *dd,
3312 const char *buf, size_t count)
3315 int tmp = poll_mode_io;
3317 struct megasas_instance *instance;
3319 if (sscanf(buf, "%u", &poll_mode_io) < 1) {
3320 printk(KERN_ERR "megasas: could not set poll_mode_io\n");
3325 * Check if poll_mode_io is already set or is same as previous value
3327 if ((tmp && poll_mode_io) || (tmp == poll_mode_io))
3332 * Start timers for all adapters
3334 for (i = 0; i < megasas_mgmt_info.max_index; i++) {
3335 instance = megasas_mgmt_info.instance[i];
3337 megasas_start_timer(instance,
3338 &instance->io_completion_timer,
3339 megasas_io_completion_timer,
3340 MEGASAS_COMPLETION_TIMER_INTERVAL);
3345 * Delete timers for all adapters
3347 for (i = 0; i < megasas_mgmt_info.max_index; i++) {
3348 instance = megasas_mgmt_info.instance[i];
3350 del_timer_sync(&instance->io_completion_timer);
3358 static DRIVER_ATTR(poll_mode_io, S_IRUGO|S_IWUGO,
3359 megasas_sysfs_show_poll_mode_io,
3360 megasas_sysfs_set_poll_mode_io);
3363 * megasas_init - Driver load entry point
3365 static int __init megasas_init(void)
3370 * Announce driver version and other information
3372 printk(KERN_INFO "megasas: %s %s\n", MEGASAS_VERSION,
3373 MEGASAS_EXT_VERSION);
3375 memset(&megasas_mgmt_info, 0, sizeof(megasas_mgmt_info));
3378 * Register character device node
3380 rval = register_chrdev(0, "megaraid_sas_ioctl", &megasas_mgmt_fops);
3383 printk(KERN_DEBUG "megasas: failed to open device node\n");
3387 megasas_mgmt_majorno = rval;
3390 * Register ourselves as PCI hotplug module
3392 rval = pci_register_driver(&megasas_pci_driver);
3395 printk(KERN_DEBUG "megasas: PCI hotplug regisration failed \n");
3399 rval = driver_create_file(&megasas_pci_driver.driver,
3400 &driver_attr_version);
3402 goto err_dcf_attr_ver;
3403 rval = driver_create_file(&megasas_pci_driver.driver,
3404 &driver_attr_release_date);
3406 goto err_dcf_rel_date;
3407 rval = driver_create_file(&megasas_pci_driver.driver,
3408 &driver_attr_dbg_lvl);
3410 goto err_dcf_dbg_lvl;
3411 rval = driver_create_file(&megasas_pci_driver.driver,
3412 &driver_attr_poll_mode_io);
3414 goto err_dcf_poll_mode_io;
3418 err_dcf_poll_mode_io:
3419 driver_remove_file(&megasas_pci_driver.driver,
3420 &driver_attr_dbg_lvl);
3422 driver_remove_file(&megasas_pci_driver.driver,
3423 &driver_attr_release_date);
3425 driver_remove_file(&megasas_pci_driver.driver, &driver_attr_version);
3427 pci_unregister_driver(&megasas_pci_driver);
3429 unregister_chrdev(megasas_mgmt_majorno, "megaraid_sas_ioctl");
3434 * megasas_exit - Driver unload entry point
3436 static void __exit megasas_exit(void)
3438 driver_remove_file(&megasas_pci_driver.driver,
3439 &driver_attr_poll_mode_io);
3440 driver_remove_file(&megasas_pci_driver.driver,
3441 &driver_attr_dbg_lvl);
3442 driver_remove_file(&megasas_pci_driver.driver,
3443 &driver_attr_release_date);
3444 driver_remove_file(&megasas_pci_driver.driver, &driver_attr_version);
3446 pci_unregister_driver(&megasas_pci_driver);
3447 unregister_chrdev(megasas_mgmt_majorno, "megaraid_sas_ioctl");
3450 module_init(megasas_init);
3451 module_exit(megasas_exit);