2 3w-sas.c -- LSI 3ware SAS/SATA-RAID Controller device driver for Linux.
4 Written By: Adam Radford <aradford@gmail.com>
6 Copyright (C) 2009 LSI Corporation.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; version 2 of the License.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
18 THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
19 CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
20 LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
21 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
22 solely responsible for determining the appropriateness of using and
23 distributing the Program and assumes all risks associated with its
24 exercise of rights under this Agreement, including but not limited to
25 the risks and costs of program errors, damage to or loss of data,
26 programs or equipment, and unavailability or interruption of operations.
28 DISCLAIMER OF LIABILITY
29 NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
30 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
32 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
33 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
34 USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
35 HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
37 You should have received a copy of the GNU General Public License
38 along with this program; if not, write to the Free Software
39 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
41 Controllers supported by this driver:
43 LSI 3ware 9750 6Gb/s SAS/SATA-RAID
45 Bugs/Comments/Suggestions should be mailed to:
50 3.26.02.000 - Initial driver release.
53 #include <linux/module.h>
54 #include <linux/reboot.h>
55 #include <linux/spinlock.h>
56 #include <linux/interrupt.h>
57 #include <linux/moduleparam.h>
58 #include <linux/errno.h>
59 #include <linux/types.h>
60 #include <linux/delay.h>
61 #include <linux/pci.h>
62 #include <linux/time.h>
63 #include <linux/mutex.h>
64 #include <linux/slab.h>
67 #include <linux/uaccess.h>
68 #include <scsi/scsi.h>
69 #include <scsi/scsi_host.h>
70 #include <scsi/scsi_tcq.h>
71 #include <scsi/scsi_cmnd.h>
75 #define TW_DRIVER_VERSION "3.26.02.000"
76 static DEFINE_MUTEX(twl_chrdev_mutex);
77 static TW_Device_Extension *twl_device_extension_list[TW_MAX_SLOT];
78 static unsigned int twl_device_extension_count;
79 static int twl_major = -1;
80 extern struct timezone sys_tz;
82 /* Module parameters */
83 MODULE_AUTHOR ("LSI");
84 MODULE_DESCRIPTION ("LSI 3ware SAS/SATA-RAID Linux Driver");
85 MODULE_LICENSE("GPL");
86 MODULE_VERSION(TW_DRIVER_VERSION);
89 module_param(use_msi, int, S_IRUGO);
90 MODULE_PARM_DESC(use_msi, "Use Message Signaled Interrupts. Default: 0");
92 /* Function prototypes */
93 static int twl_reset_device_extension(TW_Device_Extension *tw_dev, int ioctl_reset);
97 /* This function returns AENs through sysfs */
98 static ssize_t twl_sysfs_aen_read(struct file *filp, struct kobject *kobj,
99 struct bin_attribute *bin_attr,
100 char *outbuf, loff_t offset, size_t count)
102 struct device *dev = container_of(kobj, struct device, kobj);
103 struct Scsi_Host *shost = class_to_shost(dev);
104 TW_Device_Extension *tw_dev = (TW_Device_Extension *)shost->hostdata;
105 unsigned long flags = 0;
108 if (!capable(CAP_SYS_ADMIN))
111 spin_lock_irqsave(tw_dev->host->host_lock, flags);
112 ret = memory_read_from_buffer(outbuf, count, &offset, tw_dev->event_queue[0], sizeof(TW_Event) * TW_Q_LENGTH);
113 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
116 } /* End twl_sysfs_aen_read() */
118 /* aen_read sysfs attribute initializer */
119 static struct bin_attribute twl_sysfs_aen_read_attr = {
121 .name = "3ware_aen_read",
125 .read = twl_sysfs_aen_read
128 /* This function returns driver compatibility info through sysfs */
129 static ssize_t twl_sysfs_compat_info(struct file *filp, struct kobject *kobj,
130 struct bin_attribute *bin_attr,
131 char *outbuf, loff_t offset, size_t count)
133 struct device *dev = container_of(kobj, struct device, kobj);
134 struct Scsi_Host *shost = class_to_shost(dev);
135 TW_Device_Extension *tw_dev = (TW_Device_Extension *)shost->hostdata;
136 unsigned long flags = 0;
139 if (!capable(CAP_SYS_ADMIN))
142 spin_lock_irqsave(tw_dev->host->host_lock, flags);
143 ret = memory_read_from_buffer(outbuf, count, &offset, &tw_dev->tw_compat_info, sizeof(TW_Compatibility_Info));
144 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
147 } /* End twl_sysfs_compat_info() */
149 /* compat_info sysfs attribute initializer */
150 static struct bin_attribute twl_sysfs_compat_info_attr = {
152 .name = "3ware_compat_info",
156 .read = twl_sysfs_compat_info
159 /* Show some statistics about the card */
160 static ssize_t twl_show_stats(struct device *dev,
161 struct device_attribute *attr, char *buf)
163 struct Scsi_Host *host = class_to_shost(dev);
164 TW_Device_Extension *tw_dev = (TW_Device_Extension *)host->hostdata;
165 unsigned long flags = 0;
168 spin_lock_irqsave(tw_dev->host->host_lock, flags);
169 len = snprintf(buf, PAGE_SIZE, "3w-sas Driver version: %s\n"
170 "Current commands posted: %4d\n"
171 "Max commands posted: %4d\n"
172 "Last sgl length: %4d\n"
173 "Max sgl length: %4d\n"
174 "Last sector count: %4d\n"
175 "Max sector count: %4d\n"
176 "SCSI Host Resets: %4d\n"
179 tw_dev->posted_request_count,
180 tw_dev->max_posted_request_count,
182 tw_dev->max_sgl_entries,
183 tw_dev->sector_count,
184 tw_dev->max_sector_count,
187 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
189 } /* End twl_show_stats() */
191 /* stats sysfs attribute initializer */
192 static struct device_attribute twl_host_stats_attr = {
194 .name = "3ware_stats",
197 .show = twl_show_stats
200 /* Host attributes initializer */
201 static struct device_attribute *twl_host_attrs[] = {
202 &twl_host_stats_attr,
206 /* This function will look up an AEN severity string */
207 static char *twl_aen_severity_lookup(unsigned char severity_code)
211 if ((severity_code < (unsigned char) TW_AEN_SEVERITY_ERROR) ||
212 (severity_code > (unsigned char) TW_AEN_SEVERITY_DEBUG))
215 retval = twl_aen_severity_table[severity_code];
218 } /* End twl_aen_severity_lookup() */
220 /* This function will queue an event */
221 static void twl_aen_queue_event(TW_Device_Extension *tw_dev, TW_Command_Apache_Header *header)
231 /* Fill out event info */
232 event = tw_dev->event_queue[tw_dev->error_index];
236 sprintf(host, " scsi%d:", tw_dev->host->host_no);
238 aen = le16_to_cpu(header->status_block.error);
239 memset(event, 0, sizeof(TW_Event));
241 event->severity = TW_SEV_OUT(header->status_block.severity__reserved);
242 /* event->time_stamp_sec overflows in y2106 */
243 local_time = (u32)(ktime_get_real_seconds() - (sys_tz.tz_minuteswest * 60));
244 event->time_stamp_sec = local_time;
245 event->aen_code = aen;
246 event->retrieved = TW_AEN_NOT_RETRIEVED;
247 event->sequence_id = tw_dev->error_sequence_id;
248 tw_dev->error_sequence_id++;
250 /* Check for embedded error string */
251 error_str = &(header->err_specific_desc[strlen(header->err_specific_desc)+1]);
253 header->err_specific_desc[sizeof(header->err_specific_desc) - 1] = '\0';
254 event->parameter_len = strlen(header->err_specific_desc);
255 memcpy(event->parameter_data, header->err_specific_desc, event->parameter_len + 1 + strlen(error_str));
256 if (event->severity != TW_AEN_SEVERITY_DEBUG)
257 printk(KERN_WARNING "3w-sas:%s AEN: %s (0x%02X:0x%04X): %s:%s.\n",
259 twl_aen_severity_lookup(TW_SEV_OUT(header->status_block.severity__reserved)),
260 TW_MESSAGE_SOURCE_CONTROLLER_EVENT, aen, error_str,
261 header->err_specific_desc);
265 tw_dev->error_index = (tw_dev->error_index + 1 ) % TW_Q_LENGTH;
266 } /* End twl_aen_queue_event() */
268 /* This function will attempt to post a command packet to the board */
269 static int twl_post_command_packet(TW_Device_Extension *tw_dev, int request_id)
271 dma_addr_t command_que_value;
273 command_que_value = tw_dev->command_packet_phys[request_id];
274 command_que_value += TW_COMMAND_OFFSET;
276 /* First write upper 4 bytes */
277 writel((u32)((u64)command_que_value >> 32), TWL_HIBQPH_REG_ADDR(tw_dev));
278 /* Then the lower 4 bytes */
279 writel((u32)(command_que_value | TWL_PULL_MODE), TWL_HIBQPL_REG_ADDR(tw_dev));
281 tw_dev->state[request_id] = TW_S_POSTED;
282 tw_dev->posted_request_count++;
283 if (tw_dev->posted_request_count > tw_dev->max_posted_request_count)
284 tw_dev->max_posted_request_count = tw_dev->posted_request_count;
287 } /* End twl_post_command_packet() */
289 /* This function hands scsi cdb's to the firmware */
290 static int twl_scsiop_execute_scsi(TW_Device_Extension *tw_dev, int request_id,
291 unsigned char *cdb, int use_sg,
292 TW_SG_Entry_ISO *sglistarg)
294 TW_Command_Full *full_command_packet;
295 TW_Command_Apache *command_packet;
297 struct scsi_cmnd *srb = NULL;
298 struct scatterlist *sg;
301 if (tw_dev->srb[request_id])
302 srb = tw_dev->srb[request_id];
304 /* Initialize command packet */
305 full_command_packet = tw_dev->command_packet_virt[request_id];
306 full_command_packet->header.header_desc.size_header = 128;
307 full_command_packet->header.status_block.error = 0;
308 full_command_packet->header.status_block.severity__reserved = 0;
310 command_packet = &full_command_packet->command.newcommand;
311 command_packet->status = 0;
312 command_packet->opcode__reserved = TW_OPRES_IN(0, TW_OP_EXECUTE_SCSI);
314 /* We forced 16 byte cdb use earlier */
316 memcpy(command_packet->cdb, srb->cmnd, TW_MAX_CDB_LEN);
318 memcpy(command_packet->cdb, cdb, TW_MAX_CDB_LEN);
321 command_packet->unit = srb->device->id;
322 command_packet->request_id__lunl =
323 cpu_to_le16(TW_REQ_LUN_IN(srb->device->lun, request_id));
325 command_packet->request_id__lunl =
326 cpu_to_le16(TW_REQ_LUN_IN(0, request_id));
327 command_packet->unit = 0;
330 command_packet->sgl_offset = 16;
333 /* Map sglist from scsi layer to cmd packet */
334 if (scsi_sg_count(srb)) {
335 sg_count = scsi_dma_map(srb);
339 scsi_for_each_sg(srb, sg, sg_count, i) {
340 command_packet->sg_list[i].address = TW_CPU_TO_SGL(sg_dma_address(sg));
341 command_packet->sg_list[i].length = TW_CPU_TO_SGL(sg_dma_len(sg));
343 command_packet->sgl_entries__lunh = cpu_to_le16(TW_REQ_LUN_IN((srb->device->lun >> 4), scsi_sg_count(tw_dev->srb[request_id])));
346 /* Internal cdb post */
347 for (i = 0; i < use_sg; i++) {
348 command_packet->sg_list[i].address = TW_CPU_TO_SGL(sglistarg[i].address);
349 command_packet->sg_list[i].length = TW_CPU_TO_SGL(sglistarg[i].length);
351 command_packet->sgl_entries__lunh = cpu_to_le16(TW_REQ_LUN_IN(0, use_sg));
354 /* Update some stats */
356 tw_dev->sector_count = scsi_bufflen(srb) / 512;
357 if (tw_dev->sector_count > tw_dev->max_sector_count)
358 tw_dev->max_sector_count = tw_dev->sector_count;
359 tw_dev->sgl_entries = scsi_sg_count(srb);
360 if (tw_dev->sgl_entries > tw_dev->max_sgl_entries)
361 tw_dev->max_sgl_entries = tw_dev->sgl_entries;
364 /* Now post the command to the board */
365 retval = twl_post_command_packet(tw_dev, request_id);
369 } /* End twl_scsiop_execute_scsi() */
371 /* This function will read the aen queue from the isr */
372 static int twl_aen_read_queue(TW_Device_Extension *tw_dev, int request_id)
374 unsigned char cdb[TW_MAX_CDB_LEN];
375 TW_SG_Entry_ISO sglist[1];
376 TW_Command_Full *full_command_packet;
379 full_command_packet = tw_dev->command_packet_virt[request_id];
380 memset(full_command_packet, 0, sizeof(TW_Command_Full));
383 memset(&cdb, 0, TW_MAX_CDB_LEN);
384 cdb[0] = REQUEST_SENSE; /* opcode */
385 cdb[4] = TW_ALLOCATION_LENGTH; /* allocation length */
387 /* Initialize sglist */
388 memset(&sglist, 0, sizeof(TW_SG_Entry_ISO));
389 sglist[0].length = TW_SECTOR_SIZE;
390 sglist[0].address = tw_dev->generic_buffer_phys[request_id];
392 /* Mark internal command */
393 tw_dev->srb[request_id] = NULL;
395 /* Now post the command packet */
396 if (twl_scsiop_execute_scsi(tw_dev, request_id, cdb, 1, sglist)) {
397 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x2, "Post failed while reading AEN queue");
403 } /* End twl_aen_read_queue() */
405 /* This function will sync firmware time with the host time */
406 static void twl_aen_sync_time(TW_Device_Extension *tw_dev, int request_id)
409 TW_Command_Full *full_command_packet;
410 TW_Command *command_packet;
411 TW_Param_Apache *param;
414 /* Fill out the command packet */
415 full_command_packet = tw_dev->command_packet_virt[request_id];
416 memset(full_command_packet, 0, sizeof(TW_Command_Full));
417 command_packet = &full_command_packet->command.oldcommand;
418 command_packet->opcode__sgloffset = TW_OPSGL_IN(2, TW_OP_SET_PARAM);
419 command_packet->request_id = request_id;
420 command_packet->byte8_offset.param.sgl[0].address = TW_CPU_TO_SGL(tw_dev->generic_buffer_phys[request_id]);
421 command_packet->byte8_offset.param.sgl[0].length = TW_CPU_TO_SGL(TW_SECTOR_SIZE);
422 command_packet->size = TW_COMMAND_SIZE;
423 command_packet->byte6_offset.parameter_count = cpu_to_le16(1);
425 /* Setup the param */
426 param = (TW_Param_Apache *)tw_dev->generic_buffer_virt[request_id];
427 memset(param, 0, TW_SECTOR_SIZE);
428 param->table_id = cpu_to_le16(TW_TIMEKEEP_TABLE | 0x8000); /* Controller time keep table */
429 param->parameter_id = cpu_to_le16(0x3); /* SchedulerTime */
430 param->parameter_size_bytes = cpu_to_le16(4);
432 /* Convert system time in UTC to local time seconds since last
434 local_time = (ktime_get_real_seconds() - (sys_tz.tz_minuteswest * 60));
435 div_u64_rem(local_time - (3 * 86400), 604800, &schedulertime);
436 schedulertime = cpu_to_le32(schedulertime);
438 memcpy(param->data, &schedulertime, sizeof(u32));
440 /* Mark internal command */
441 tw_dev->srb[request_id] = NULL;
443 /* Now post the command */
444 twl_post_command_packet(tw_dev, request_id);
445 } /* End twl_aen_sync_time() */
447 /* This function will assign an available request id */
448 static void twl_get_request_id(TW_Device_Extension *tw_dev, int *request_id)
450 *request_id = tw_dev->free_queue[tw_dev->free_head];
451 tw_dev->free_head = (tw_dev->free_head + 1) % TW_Q_LENGTH;
452 tw_dev->state[*request_id] = TW_S_STARTED;
453 } /* End twl_get_request_id() */
455 /* This function will free a request id */
456 static void twl_free_request_id(TW_Device_Extension *tw_dev, int request_id)
458 tw_dev->free_queue[tw_dev->free_tail] = request_id;
459 tw_dev->state[request_id] = TW_S_FINISHED;
460 tw_dev->free_tail = (tw_dev->free_tail + 1) % TW_Q_LENGTH;
461 } /* End twl_free_request_id() */
463 /* This function will complete an aen request from the isr */
464 static int twl_aen_complete(TW_Device_Extension *tw_dev, int request_id)
466 TW_Command_Full *full_command_packet;
467 TW_Command *command_packet;
468 TW_Command_Apache_Header *header;
472 header = (TW_Command_Apache_Header *)tw_dev->generic_buffer_virt[request_id];
473 tw_dev->posted_request_count--;
474 aen = le16_to_cpu(header->status_block.error);
475 full_command_packet = tw_dev->command_packet_virt[request_id];
476 command_packet = &full_command_packet->command.oldcommand;
478 /* First check for internal completion of set param for time sync */
479 if (TW_OP_OUT(command_packet->opcode__sgloffset) == TW_OP_SET_PARAM) {
480 /* Keep reading the queue in case there are more aen's */
481 if (twl_aen_read_queue(tw_dev, request_id))
490 case TW_AEN_QUEUE_EMPTY:
491 /* Quit reading the queue if this is the last one */
493 case TW_AEN_SYNC_TIME_WITH_HOST:
494 twl_aen_sync_time(tw_dev, request_id);
498 twl_aen_queue_event(tw_dev, header);
500 /* If there are more aen's, keep reading the queue */
501 if (twl_aen_read_queue(tw_dev, request_id))
510 tw_dev->state[request_id] = TW_S_COMPLETED;
511 twl_free_request_id(tw_dev, request_id);
512 clear_bit(TW_IN_ATTENTION_LOOP, &tw_dev->flags);
515 } /* End twl_aen_complete() */
517 /* This function will poll for a response */
518 static int twl_poll_response(TW_Device_Extension *tw_dev, int request_id, int seconds)
520 unsigned long before;
530 if (sizeof(dma_addr_t) > 4) {
531 regh = readl(TWL_HOBQPH_REG_ADDR(tw_dev));
532 regl = readl(TWL_HOBQPL_REG_ADDR(tw_dev));
533 mfa = ((u64)regh << 32) | regl;
535 mfa = readl(TWL_HOBQPL_REG_ADDR(tw_dev));
539 if (TW_RESID_OUT(response) == request_id)
542 if (time_after(jiffies, before + HZ * seconds))
550 } /* End twl_poll_response() */
552 /* This function will drain the aen queue */
553 static int twl_aen_drain_queue(TW_Device_Extension *tw_dev, int no_check_reset)
556 unsigned char cdb[TW_MAX_CDB_LEN];
557 TW_SG_Entry_ISO sglist[1];
558 int finished = 0, count = 0;
559 TW_Command_Full *full_command_packet;
560 TW_Command_Apache_Header *header;
562 int first_reset = 0, queue = 0, retval = 1;
569 full_command_packet = tw_dev->command_packet_virt[request_id];
570 memset(full_command_packet, 0, sizeof(TW_Command_Full));
573 memset(&cdb, 0, TW_MAX_CDB_LEN);
574 cdb[0] = REQUEST_SENSE; /* opcode */
575 cdb[4] = TW_ALLOCATION_LENGTH; /* allocation length */
577 /* Initialize sglist */
578 memset(&sglist, 0, sizeof(TW_SG_Entry_ISO));
579 sglist[0].length = TW_SECTOR_SIZE;
580 sglist[0].address = tw_dev->generic_buffer_phys[request_id];
582 /* Mark internal command */
583 tw_dev->srb[request_id] = NULL;
586 /* Send command to the board */
587 if (twl_scsiop_execute_scsi(tw_dev, request_id, cdb, 1, sglist)) {
588 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x3, "Error posting request sense");
592 /* Now poll for completion */
593 if (twl_poll_response(tw_dev, request_id, 30)) {
594 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x4, "No valid response while draining AEN queue");
595 tw_dev->posted_request_count--;
599 tw_dev->posted_request_count--;
600 header = (TW_Command_Apache_Header *)tw_dev->generic_buffer_virt[request_id];
601 aen = le16_to_cpu(header->status_block.error);
606 case TW_AEN_QUEUE_EMPTY:
607 if (first_reset != 1)
612 case TW_AEN_SOFT_RESET:
613 if (first_reset == 0)
618 case TW_AEN_SYNC_TIME_WITH_HOST:
624 /* Now queue an event info */
626 twl_aen_queue_event(tw_dev, header);
627 } while ((finished == 0) && (count < TW_MAX_AEN_DRAIN));
629 if (count == TW_MAX_AEN_DRAIN)
634 tw_dev->state[request_id] = TW_S_INITIAL;
636 } /* End twl_aen_drain_queue() */
638 /* This function will allocate memory and check if it is correctly aligned */
639 static int twl_allocate_memory(TW_Device_Extension *tw_dev, int size, int which)
642 dma_addr_t dma_handle;
643 unsigned long *cpu_addr;
646 cpu_addr = dma_alloc_coherent(&tw_dev->tw_pci_dev->dev,
647 size * TW_Q_LENGTH, &dma_handle,
650 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x5, "Memory allocation failed");
654 for (i = 0; i < TW_Q_LENGTH; i++) {
657 tw_dev->command_packet_phys[i] = dma_handle+(i*size);
658 tw_dev->command_packet_virt[i] = (TW_Command_Full *)((unsigned char *)cpu_addr + (i*size));
661 tw_dev->generic_buffer_phys[i] = dma_handle+(i*size);
662 tw_dev->generic_buffer_virt[i] = (unsigned long *)((unsigned char *)cpu_addr + (i*size));
665 tw_dev->sense_buffer_phys[i] = dma_handle+(i*size);
666 tw_dev->sense_buffer_virt[i] = (TW_Command_Apache_Header *)((unsigned char *)cpu_addr + (i*size));
673 } /* End twl_allocate_memory() */
675 /* This function will load the request id and various sgls for ioctls */
676 static void twl_load_sgl(TW_Device_Extension *tw_dev, TW_Command_Full *full_command_packet, int request_id, dma_addr_t dma_handle, int length)
678 TW_Command *oldcommand;
679 TW_Command_Apache *newcommand;
680 TW_SG_Entry_ISO *sgl;
681 unsigned int pae = 0;
683 if ((sizeof(long) < 8) && (sizeof(dma_addr_t) > 4))
686 if (TW_OP_OUT(full_command_packet->command.newcommand.opcode__reserved) == TW_OP_EXECUTE_SCSI) {
687 newcommand = &full_command_packet->command.newcommand;
688 newcommand->request_id__lunl =
689 cpu_to_le16(TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->request_id__lunl), request_id));
691 newcommand->sg_list[0].address = TW_CPU_TO_SGL(dma_handle + sizeof(TW_Ioctl_Buf_Apache) - 1);
692 newcommand->sg_list[0].length = TW_CPU_TO_SGL(length);
694 newcommand->sgl_entries__lunh =
695 cpu_to_le16(TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->sgl_entries__lunh), length ? 1 : 0));
697 oldcommand = &full_command_packet->command.oldcommand;
698 oldcommand->request_id = request_id;
700 if (TW_SGL_OUT(oldcommand->opcode__sgloffset)) {
701 /* Load the sg list */
702 sgl = (TW_SG_Entry_ISO *)((u32 *)oldcommand+oldcommand->size - (sizeof(TW_SG_Entry_ISO)/4) + pae + (sizeof(dma_addr_t) > 4 ? 1 : 0));
703 sgl->address = TW_CPU_TO_SGL(dma_handle + sizeof(TW_Ioctl_Buf_Apache) - 1);
704 sgl->length = TW_CPU_TO_SGL(length);
705 oldcommand->size += pae;
706 oldcommand->size += sizeof(dma_addr_t) > 4 ? 1 : 0;
709 } /* End twl_load_sgl() */
711 /* This function handles ioctl for the character device
712 This interface is used by smartmontools open source software */
713 static long twl_chrdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
716 unsigned long *cpu_addr, data_buffer_length_adjusted = 0, flags = 0;
717 dma_addr_t dma_handle;
719 TW_Ioctl_Driver_Command driver_command;
720 struct inode *inode = file_inode(file);
721 TW_Ioctl_Buf_Apache *tw_ioctl;
722 TW_Command_Full *full_command_packet;
723 TW_Device_Extension *tw_dev = twl_device_extension_list[iminor(inode)];
724 int retval = -EFAULT;
725 void __user *argp = (void __user *)arg;
727 mutex_lock(&twl_chrdev_mutex);
729 /* Only let one of these through at a time */
730 if (mutex_lock_interruptible(&tw_dev->ioctl_lock)) {
735 /* First copy down the driver command */
736 if (copy_from_user(&driver_command, argp, sizeof(TW_Ioctl_Driver_Command)))
739 /* Check data buffer size */
740 if (driver_command.buffer_length > TW_MAX_SECTORS * 2048) {
745 /* Hardware can only do multiple of 512 byte transfers */
746 data_buffer_length_adjusted = (driver_command.buffer_length + 511) & ~511;
748 /* Now allocate ioctl buf memory */
749 cpu_addr = dma_alloc_coherent(&tw_dev->tw_pci_dev->dev, data_buffer_length_adjusted+sizeof(TW_Ioctl_Buf_Apache) - 1, &dma_handle, GFP_KERNEL);
755 tw_ioctl = (TW_Ioctl_Buf_Apache *)cpu_addr;
757 /* Now copy down the entire ioctl */
758 if (copy_from_user(tw_ioctl, argp, driver_command.buffer_length + sizeof(TW_Ioctl_Buf_Apache) - 1))
761 /* See which ioctl we are doing */
763 case TW_IOCTL_FIRMWARE_PASS_THROUGH:
764 spin_lock_irqsave(tw_dev->host->host_lock, flags);
765 twl_get_request_id(tw_dev, &request_id);
767 /* Flag internal command */
768 tw_dev->srb[request_id] = NULL;
770 /* Flag chrdev ioctl */
771 tw_dev->chrdev_request_id = request_id;
773 full_command_packet = (TW_Command_Full *)&tw_ioctl->firmware_command;
775 /* Load request id and sglist for both command types */
776 twl_load_sgl(tw_dev, full_command_packet, request_id, dma_handle, data_buffer_length_adjusted);
778 memcpy(tw_dev->command_packet_virt[request_id], &(tw_ioctl->firmware_command), sizeof(TW_Command_Full));
780 /* Now post the command packet to the controller */
781 twl_post_command_packet(tw_dev, request_id);
782 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
784 timeout = TW_IOCTL_CHRDEV_TIMEOUT*HZ;
786 /* Now wait for command to complete */
787 timeout = wait_event_timeout(tw_dev->ioctl_wqueue, tw_dev->chrdev_request_id == TW_IOCTL_CHRDEV_FREE, timeout);
789 /* We timed out, and didn't get an interrupt */
790 if (tw_dev->chrdev_request_id != TW_IOCTL_CHRDEV_FREE) {
791 /* Now we need to reset the board */
792 printk(KERN_WARNING "3w-sas: scsi%d: WARNING: (0x%02X:0x%04X): Character ioctl (0x%x) timed out, resetting card.\n",
793 tw_dev->host->host_no, TW_DRIVER, 0x6,
796 twl_reset_device_extension(tw_dev, 1);
800 /* Now copy in the command packet response */
801 memcpy(&(tw_ioctl->firmware_command), tw_dev->command_packet_virt[request_id], sizeof(TW_Command_Full));
803 /* Now complete the io */
804 spin_lock_irqsave(tw_dev->host->host_lock, flags);
805 tw_dev->posted_request_count--;
806 tw_dev->state[request_id] = TW_S_COMPLETED;
807 twl_free_request_id(tw_dev, request_id);
808 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
815 /* Now copy the entire response to userspace */
816 if (copy_to_user(argp, tw_ioctl, sizeof(TW_Ioctl_Buf_Apache) + driver_command.buffer_length - 1) == 0)
819 /* Now free ioctl buf memory */
820 dma_free_coherent(&tw_dev->tw_pci_dev->dev, data_buffer_length_adjusted+sizeof(TW_Ioctl_Buf_Apache) - 1, cpu_addr, dma_handle);
822 mutex_unlock(&tw_dev->ioctl_lock);
824 mutex_unlock(&twl_chrdev_mutex);
826 } /* End twl_chrdev_ioctl() */
828 /* This function handles open for the character device */
829 static int twl_chrdev_open(struct inode *inode, struct file *file)
831 unsigned int minor_number;
832 int retval = -ENODEV;
834 if (!capable(CAP_SYS_ADMIN)) {
839 minor_number = iminor(inode);
840 if (minor_number >= twl_device_extension_count)
845 } /* End twl_chrdev_open() */
847 /* File operations struct for character device */
848 static const struct file_operations twl_fops = {
849 .owner = THIS_MODULE,
850 .unlocked_ioctl = twl_chrdev_ioctl,
851 .open = twl_chrdev_open,
853 .llseek = noop_llseek,
856 /* This function passes sense data from firmware to scsi layer */
857 static int twl_fill_sense(TW_Device_Extension *tw_dev, int i, int request_id, int copy_sense, int print_host)
859 TW_Command_Apache_Header *header;
860 TW_Command_Full *full_command_packet;
861 unsigned short error;
864 header = tw_dev->sense_buffer_virt[i];
865 full_command_packet = tw_dev->command_packet_virt[request_id];
867 /* Get embedded firmware error string */
868 error_str = &(header->err_specific_desc[strlen(header->err_specific_desc) + 1]);
870 /* Don't print error for Logical unit not supported during rollcall */
871 error = le16_to_cpu(header->status_block.error);
872 if ((error != TW_ERROR_LOGICAL_UNIT_NOT_SUPPORTED) && (error != TW_ERROR_UNIT_OFFLINE) && (error != TW_ERROR_INVALID_FIELD_IN_CDB)) {
874 printk(KERN_WARNING "3w-sas: scsi%d: ERROR: (0x%02X:0x%04X): %s:%s.\n",
875 tw_dev->host->host_no,
876 TW_MESSAGE_SOURCE_CONTROLLER_ERROR,
877 header->status_block.error,
879 header->err_specific_desc);
881 printk(KERN_WARNING "3w-sas: ERROR: (0x%02X:0x%04X): %s:%s.\n",
882 TW_MESSAGE_SOURCE_CONTROLLER_ERROR,
883 header->status_block.error,
885 header->err_specific_desc);
889 memcpy(tw_dev->srb[request_id]->sense_buffer, header->sense_data, TW_SENSE_DATA_LENGTH);
890 tw_dev->srb[request_id]->result = (full_command_packet->command.newcommand.status << 1);
895 } /* End twl_fill_sense() */
897 /* This function will free up device extension resources */
898 static void twl_free_device_extension(TW_Device_Extension *tw_dev)
900 if (tw_dev->command_packet_virt[0])
901 dma_free_coherent(&tw_dev->tw_pci_dev->dev,
902 sizeof(TW_Command_Full)*TW_Q_LENGTH,
903 tw_dev->command_packet_virt[0],
904 tw_dev->command_packet_phys[0]);
906 if (tw_dev->generic_buffer_virt[0])
907 dma_free_coherent(&tw_dev->tw_pci_dev->dev,
908 TW_SECTOR_SIZE*TW_Q_LENGTH,
909 tw_dev->generic_buffer_virt[0],
910 tw_dev->generic_buffer_phys[0]);
912 if (tw_dev->sense_buffer_virt[0])
913 dma_free_coherent(&tw_dev->tw_pci_dev->dev,
914 sizeof(TW_Command_Apache_Header)*
916 tw_dev->sense_buffer_virt[0],
917 tw_dev->sense_buffer_phys[0]);
919 kfree(tw_dev->event_queue[0]);
920 } /* End twl_free_device_extension() */
922 /* This function will get parameter table entries from the firmware */
923 static void *twl_get_param(TW_Device_Extension *tw_dev, int request_id, int table_id, int parameter_id, int parameter_size_bytes)
925 TW_Command_Full *full_command_packet;
926 TW_Command *command_packet;
927 TW_Param_Apache *param;
930 /* Setup the command packet */
931 full_command_packet = tw_dev->command_packet_virt[request_id];
932 memset(full_command_packet, 0, sizeof(TW_Command_Full));
933 command_packet = &full_command_packet->command.oldcommand;
935 command_packet->opcode__sgloffset = TW_OPSGL_IN(2, TW_OP_GET_PARAM);
936 command_packet->size = TW_COMMAND_SIZE;
937 command_packet->request_id = request_id;
938 command_packet->byte6_offset.block_count = cpu_to_le16(1);
940 /* Now setup the param */
941 param = (TW_Param_Apache *)tw_dev->generic_buffer_virt[request_id];
942 memset(param, 0, TW_SECTOR_SIZE);
943 param->table_id = cpu_to_le16(table_id | 0x8000);
944 param->parameter_id = cpu_to_le16(parameter_id);
945 param->parameter_size_bytes = cpu_to_le16(parameter_size_bytes);
947 command_packet->byte8_offset.param.sgl[0].address = TW_CPU_TO_SGL(tw_dev->generic_buffer_phys[request_id]);
948 command_packet->byte8_offset.param.sgl[0].length = TW_CPU_TO_SGL(TW_SECTOR_SIZE);
950 /* Post the command packet to the board */
951 twl_post_command_packet(tw_dev, request_id);
953 /* Poll for completion */
954 if (twl_poll_response(tw_dev, request_id, 30))
955 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x7, "No valid response during get param")
957 retval = (void *)&(param->data[0]);
959 tw_dev->posted_request_count--;
960 tw_dev->state[request_id] = TW_S_INITIAL;
963 } /* End twl_get_param() */
965 /* This function will send an initconnection command to controller */
966 static int twl_initconnection(TW_Device_Extension *tw_dev, int message_credits,
967 u32 set_features, unsigned short current_fw_srl,
968 unsigned short current_fw_arch_id,
969 unsigned short current_fw_branch,
970 unsigned short current_fw_build,
971 unsigned short *fw_on_ctlr_srl,
972 unsigned short *fw_on_ctlr_arch_id,
973 unsigned short *fw_on_ctlr_branch,
974 unsigned short *fw_on_ctlr_build,
975 u32 *init_connect_result)
977 TW_Command_Full *full_command_packet;
978 TW_Initconnect *tw_initconnect;
979 int request_id = 0, retval = 1;
981 /* Initialize InitConnection command packet */
982 full_command_packet = tw_dev->command_packet_virt[request_id];
983 memset(full_command_packet, 0, sizeof(TW_Command_Full));
984 full_command_packet->header.header_desc.size_header = 128;
986 tw_initconnect = (TW_Initconnect *)&full_command_packet->command.oldcommand;
987 tw_initconnect->opcode__reserved = TW_OPRES_IN(0, TW_OP_INIT_CONNECTION);
988 tw_initconnect->request_id = request_id;
989 tw_initconnect->message_credits = cpu_to_le16(message_credits);
990 tw_initconnect->features = set_features;
992 /* Turn on 64-bit sgl support if we need to */
993 tw_initconnect->features |= sizeof(dma_addr_t) > 4 ? 1 : 0;
995 tw_initconnect->features = cpu_to_le32(tw_initconnect->features);
997 if (set_features & TW_EXTENDED_INIT_CONNECT) {
998 tw_initconnect->size = TW_INIT_COMMAND_PACKET_SIZE_EXTENDED;
999 tw_initconnect->fw_srl = cpu_to_le16(current_fw_srl);
1000 tw_initconnect->fw_arch_id = cpu_to_le16(current_fw_arch_id);
1001 tw_initconnect->fw_branch = cpu_to_le16(current_fw_branch);
1002 tw_initconnect->fw_build = cpu_to_le16(current_fw_build);
1004 tw_initconnect->size = TW_INIT_COMMAND_PACKET_SIZE;
1006 /* Send command packet to the board */
1007 twl_post_command_packet(tw_dev, request_id);
1009 /* Poll for completion */
1010 if (twl_poll_response(tw_dev, request_id, 30)) {
1011 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x8, "No valid response during init connection");
1013 if (set_features & TW_EXTENDED_INIT_CONNECT) {
1014 *fw_on_ctlr_srl = le16_to_cpu(tw_initconnect->fw_srl);
1015 *fw_on_ctlr_arch_id = le16_to_cpu(tw_initconnect->fw_arch_id);
1016 *fw_on_ctlr_branch = le16_to_cpu(tw_initconnect->fw_branch);
1017 *fw_on_ctlr_build = le16_to_cpu(tw_initconnect->fw_build);
1018 *init_connect_result = le32_to_cpu(tw_initconnect->result);
1023 tw_dev->posted_request_count--;
1024 tw_dev->state[request_id] = TW_S_INITIAL;
1027 } /* End twl_initconnection() */
1029 /* This function will initialize the fields of a device extension */
1030 static int twl_initialize_device_extension(TW_Device_Extension *tw_dev)
1034 /* Initialize command packet buffers */
1035 if (twl_allocate_memory(tw_dev, sizeof(TW_Command_Full), 0)) {
1036 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x9, "Command packet memory allocation failed");
1040 /* Initialize generic buffer */
1041 if (twl_allocate_memory(tw_dev, TW_SECTOR_SIZE, 1)) {
1042 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xa, "Generic memory allocation failed");
1046 /* Allocate sense buffers */
1047 if (twl_allocate_memory(tw_dev, sizeof(TW_Command_Apache_Header), 2)) {
1048 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xb, "Sense buffer allocation failed");
1052 /* Allocate event info space */
1053 tw_dev->event_queue[0] = kcalloc(TW_Q_LENGTH, sizeof(TW_Event), GFP_KERNEL);
1054 if (!tw_dev->event_queue[0]) {
1055 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xc, "Event info memory allocation failed");
1059 for (i = 0; i < TW_Q_LENGTH; i++) {
1060 tw_dev->event_queue[i] = (TW_Event *)((unsigned char *)tw_dev->event_queue[0] + (i * sizeof(TW_Event)));
1061 tw_dev->free_queue[i] = i;
1062 tw_dev->state[i] = TW_S_INITIAL;
1065 tw_dev->free_head = TW_Q_START;
1066 tw_dev->free_tail = TW_Q_START;
1067 tw_dev->error_sequence_id = 1;
1068 tw_dev->chrdev_request_id = TW_IOCTL_CHRDEV_FREE;
1070 mutex_init(&tw_dev->ioctl_lock);
1071 init_waitqueue_head(&tw_dev->ioctl_wqueue);
1076 } /* End twl_initialize_device_extension() */
1078 /* This function will handle attention interrupts */
1079 static int twl_handle_attention_interrupt(TW_Device_Extension *tw_dev)
1082 u32 request_id, doorbell;
1084 /* Read doorbell status */
1085 doorbell = readl(TWL_HOBDB_REG_ADDR(tw_dev));
1087 /* Check for controller errors */
1088 if (doorbell & TWL_DOORBELL_CONTROLLER_ERROR) {
1089 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xd, "Microcontroller Error: clearing");
1093 /* Check if we need to perform an AEN drain */
1094 if (doorbell & TWL_DOORBELL_ATTENTION_INTERRUPT) {
1095 if (!(test_and_set_bit(TW_IN_ATTENTION_LOOP, &tw_dev->flags))) {
1096 twl_get_request_id(tw_dev, &request_id);
1097 if (twl_aen_read_queue(tw_dev, request_id)) {
1098 tw_dev->state[request_id] = TW_S_COMPLETED;
1099 twl_free_request_id(tw_dev, request_id);
1100 clear_bit(TW_IN_ATTENTION_LOOP, &tw_dev->flags);
1107 /* Clear doorbell interrupt */
1108 TWL_CLEAR_DB_INTERRUPT(tw_dev);
1110 /* Make sure the clear was flushed by reading it back */
1111 readl(TWL_HOBDBC_REG_ADDR(tw_dev));
1114 } /* End twl_handle_attention_interrupt() */
1116 /* Interrupt service routine */
1117 static irqreturn_t twl_interrupt(int irq, void *dev_instance)
1119 TW_Device_Extension *tw_dev = (TW_Device_Extension *)dev_instance;
1120 int i, handled = 0, error = 0;
1122 u32 reg, regl, regh, response, request_id = 0;
1123 struct scsi_cmnd *cmd;
1124 TW_Command_Full *full_command_packet;
1126 spin_lock(tw_dev->host->host_lock);
1128 /* Read host interrupt status */
1129 reg = readl(TWL_HISTAT_REG_ADDR(tw_dev));
1131 /* Check if this is our interrupt, otherwise bail */
1132 if (!(reg & TWL_HISTATUS_VALID_INTERRUPT))
1133 goto twl_interrupt_bail;
1137 /* If we are resetting, bail */
1138 if (test_bit(TW_IN_RESET, &tw_dev->flags))
1139 goto twl_interrupt_bail;
1141 /* Attention interrupt */
1142 if (reg & TWL_HISTATUS_ATTENTION_INTERRUPT) {
1143 if (twl_handle_attention_interrupt(tw_dev)) {
1144 TWL_MASK_INTERRUPTS(tw_dev);
1145 goto twl_interrupt_bail;
1149 /* Response interrupt */
1150 while (reg & TWL_HISTATUS_RESPONSE_INTERRUPT) {
1151 if (sizeof(dma_addr_t) > 4) {
1152 regh = readl(TWL_HOBQPH_REG_ADDR(tw_dev));
1153 regl = readl(TWL_HOBQPL_REG_ADDR(tw_dev));
1154 mfa = ((u64)regh << 32) | regl;
1156 mfa = readl(TWL_HOBQPL_REG_ADDR(tw_dev));
1159 response = (u32)mfa;
1161 /* Check for command packet error */
1162 if (!TW_NOTMFA_OUT(response)) {
1163 for (i=0;i<TW_Q_LENGTH;i++) {
1164 if (tw_dev->sense_buffer_phys[i] == mfa) {
1165 request_id = le16_to_cpu(tw_dev->sense_buffer_virt[i]->header_desc.request_id);
1166 if (tw_dev->srb[request_id] != NULL)
1167 error = twl_fill_sense(tw_dev, i, request_id, 1, 1);
1169 /* Skip ioctl error prints */
1170 if (request_id != tw_dev->chrdev_request_id)
1171 error = twl_fill_sense(tw_dev, i, request_id, 0, 1);
1173 memcpy(tw_dev->command_packet_virt[request_id], tw_dev->sense_buffer_virt[i], sizeof(TW_Command_Apache_Header));
1176 /* Now re-post the sense buffer */
1177 writel((u32)((u64)tw_dev->sense_buffer_phys[i] >> 32), TWL_HOBQPH_REG_ADDR(tw_dev));
1178 writel((u32)tw_dev->sense_buffer_phys[i], TWL_HOBQPL_REG_ADDR(tw_dev));
1183 request_id = TW_RESID_OUT(response);
1185 full_command_packet = tw_dev->command_packet_virt[request_id];
1187 /* Check for correct state */
1188 if (tw_dev->state[request_id] != TW_S_POSTED) {
1189 if (tw_dev->srb[request_id] != NULL) {
1190 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xe, "Received a request id that wasn't posted");
1191 TWL_MASK_INTERRUPTS(tw_dev);
1192 goto twl_interrupt_bail;
1196 /* Check for internal command completion */
1197 if (tw_dev->srb[request_id] == NULL) {
1198 if (request_id != tw_dev->chrdev_request_id) {
1199 if (twl_aen_complete(tw_dev, request_id))
1200 TW_PRINTK(tw_dev->host, TW_DRIVER, 0xf, "Error completing AEN during attention interrupt");
1202 tw_dev->chrdev_request_id = TW_IOCTL_CHRDEV_FREE;
1203 wake_up(&tw_dev->ioctl_wqueue);
1206 cmd = tw_dev->srb[request_id];
1209 cmd->result = (DID_OK << 16);
1211 /* Report residual bytes for single sgl */
1212 if ((scsi_sg_count(cmd) <= 1) && (full_command_packet->command.newcommand.status == 0)) {
1213 if (full_command_packet->command.newcommand.sg_list[0].length < scsi_bufflen(tw_dev->srb[request_id]))
1214 scsi_set_resid(cmd, scsi_bufflen(cmd) - full_command_packet->command.newcommand.sg_list[0].length);
1217 /* Now complete the io */
1218 scsi_dma_unmap(cmd);
1219 cmd->scsi_done(cmd);
1220 tw_dev->state[request_id] = TW_S_COMPLETED;
1221 twl_free_request_id(tw_dev, request_id);
1222 tw_dev->posted_request_count--;
1225 /* Check for another response interrupt */
1226 reg = readl(TWL_HISTAT_REG_ADDR(tw_dev));
1230 spin_unlock(tw_dev->host->host_lock);
1231 return IRQ_RETVAL(handled);
1232 } /* End twl_interrupt() */
1234 /* This function will poll for a register change */
1235 static int twl_poll_register(TW_Device_Extension *tw_dev, void *reg, u32 value, u32 result, int seconds)
1237 unsigned long before;
1241 reg_value = readl(reg);
1244 while ((reg_value & value) != result) {
1245 reg_value = readl(reg);
1246 if (time_after(jiffies, before + HZ * seconds))
1253 } /* End twl_poll_register() */
1255 /* This function will reset a controller */
1256 static int twl_reset_sequence(TW_Device_Extension *tw_dev, int soft_reset)
1261 unsigned short fw_on_ctlr_srl = 0, fw_on_ctlr_arch_id = 0;
1262 unsigned short fw_on_ctlr_branch = 0, fw_on_ctlr_build = 0;
1263 u32 init_connect_result = 0;
1265 int do_soft_reset = soft_reset;
1267 while (tries < TW_MAX_RESET_TRIES) {
1268 /* Do a soft reset if one is needed */
1269 if (do_soft_reset) {
1270 TWL_SOFT_RESET(tw_dev);
1272 /* Make sure controller is in a good state */
1273 if (twl_poll_register(tw_dev, TWL_SCRPD3_REG_ADDR(tw_dev), TWL_CONTROLLER_READY, 0x0, 30)) {
1274 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x10, "Controller never went non-ready during reset sequence");
1278 if (twl_poll_register(tw_dev, TWL_SCRPD3_REG_ADDR(tw_dev), TWL_CONTROLLER_READY, TWL_CONTROLLER_READY, 60)) {
1279 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x11, "Controller not ready during reset sequence");
1286 if (twl_initconnection(tw_dev, TW_INIT_MESSAGE_CREDITS,
1287 TW_EXTENDED_INIT_CONNECT, TW_CURRENT_DRIVER_SRL,
1288 TW_9750_ARCH_ID, TW_CURRENT_DRIVER_BRANCH,
1289 TW_CURRENT_DRIVER_BUILD, &fw_on_ctlr_srl,
1290 &fw_on_ctlr_arch_id, &fw_on_ctlr_branch,
1291 &fw_on_ctlr_build, &init_connect_result)) {
1292 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x12, "Initconnection failed while checking SRL");
1298 /* Load sense buffers */
1299 while (i < TW_Q_LENGTH) {
1300 writel((u32)((u64)tw_dev->sense_buffer_phys[i] >> 32), TWL_HOBQPH_REG_ADDR(tw_dev));
1301 writel((u32)tw_dev->sense_buffer_phys[i], TWL_HOBQPL_REG_ADDR(tw_dev));
1303 /* Check status for over-run after each write */
1304 status = readl(TWL_STATUS_REG_ADDR(tw_dev));
1305 if (!(status & TWL_STATUS_OVERRUN_SUBMIT))
1309 /* Now check status */
1310 status = readl(TWL_STATUS_REG_ADDR(tw_dev));
1312 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x13, "Bad controller status after loading sense buffers");
1318 /* Drain the AEN queue */
1319 if (twl_aen_drain_queue(tw_dev, soft_reset)) {
1320 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x14, "AEN drain failed during reset sequence");
1326 /* Load rest of compatibility struct */
1327 strncpy(tw_dev->tw_compat_info.driver_version, TW_DRIVER_VERSION, strlen(TW_DRIVER_VERSION));
1328 tw_dev->tw_compat_info.driver_srl_high = TW_CURRENT_DRIVER_SRL;
1329 tw_dev->tw_compat_info.driver_branch_high = TW_CURRENT_DRIVER_BRANCH;
1330 tw_dev->tw_compat_info.driver_build_high = TW_CURRENT_DRIVER_BUILD;
1331 tw_dev->tw_compat_info.driver_srl_low = TW_BASE_FW_SRL;
1332 tw_dev->tw_compat_info.driver_branch_low = TW_BASE_FW_BRANCH;
1333 tw_dev->tw_compat_info.driver_build_low = TW_BASE_FW_BUILD;
1334 tw_dev->tw_compat_info.fw_on_ctlr_srl = fw_on_ctlr_srl;
1335 tw_dev->tw_compat_info.fw_on_ctlr_branch = fw_on_ctlr_branch;
1336 tw_dev->tw_compat_info.fw_on_ctlr_build = fw_on_ctlr_build;
1338 /* If we got here, controller is in a good state */
1344 } /* End twl_reset_sequence() */
1346 /* This function will reset a device extension */
1347 static int twl_reset_device_extension(TW_Device_Extension *tw_dev, int ioctl_reset)
1349 int i = 0, retval = 1;
1350 unsigned long flags = 0;
1352 /* Block SCSI requests while we are resetting */
1354 scsi_block_requests(tw_dev->host);
1356 set_bit(TW_IN_RESET, &tw_dev->flags);
1357 TWL_MASK_INTERRUPTS(tw_dev);
1358 TWL_CLEAR_DB_INTERRUPT(tw_dev);
1360 spin_lock_irqsave(tw_dev->host->host_lock, flags);
1362 /* Abort all requests that are in progress */
1363 for (i = 0; i < TW_Q_LENGTH; i++) {
1364 if ((tw_dev->state[i] != TW_S_FINISHED) &&
1365 (tw_dev->state[i] != TW_S_INITIAL) &&
1366 (tw_dev->state[i] != TW_S_COMPLETED)) {
1367 struct scsi_cmnd *cmd = tw_dev->srb[i];
1370 cmd->result = (DID_RESET << 16);
1371 scsi_dma_unmap(cmd);
1372 cmd->scsi_done(cmd);
1377 /* Reset queues and counts */
1378 for (i = 0; i < TW_Q_LENGTH; i++) {
1379 tw_dev->free_queue[i] = i;
1380 tw_dev->state[i] = TW_S_INITIAL;
1382 tw_dev->free_head = TW_Q_START;
1383 tw_dev->free_tail = TW_Q_START;
1384 tw_dev->posted_request_count = 0;
1386 spin_unlock_irqrestore(tw_dev->host->host_lock, flags);
1388 if (twl_reset_sequence(tw_dev, 1))
1391 TWL_UNMASK_INTERRUPTS(tw_dev);
1393 clear_bit(TW_IN_RESET, &tw_dev->flags);
1394 tw_dev->chrdev_request_id = TW_IOCTL_CHRDEV_FREE;
1399 scsi_unblock_requests(tw_dev->host);
1401 } /* End twl_reset_device_extension() */
1403 /* This funciton returns unit geometry in cylinders/heads/sectors */
1404 static int twl_scsi_biosparam(struct scsi_device *sdev, struct block_device *bdev, sector_t capacity, int geom[])
1408 if (capacity >= 0x200000) {
1418 geom[2] = sector_div(capacity, heads * sectors); /* cylinders */
1421 } /* End twl_scsi_biosparam() */
1423 /* This is the new scsi eh reset function */
1424 static int twl_scsi_eh_reset(struct scsi_cmnd *SCpnt)
1426 TW_Device_Extension *tw_dev = NULL;
1427 int retval = FAILED;
1429 tw_dev = (TW_Device_Extension *)SCpnt->device->host->hostdata;
1431 tw_dev->num_resets++;
1433 sdev_printk(KERN_WARNING, SCpnt->device,
1434 "WARNING: (0x%02X:0x%04X): Command (0x%x) timed out, resetting card.\n",
1435 TW_DRIVER, 0x2c, SCpnt->cmnd[0]);
1437 /* Make sure we are not issuing an ioctl or resetting from ioctl */
1438 mutex_lock(&tw_dev->ioctl_lock);
1440 /* Now reset the card and some of the device extension data */
1441 if (twl_reset_device_extension(tw_dev, 0)) {
1442 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x15, "Controller reset failed during scsi host reset");
1448 mutex_unlock(&tw_dev->ioctl_lock);
1450 } /* End twl_scsi_eh_reset() */
1452 /* This is the main scsi queue function to handle scsi opcodes */
1453 static int twl_scsi_queue_lck(struct scsi_cmnd *SCpnt, void (*done)(struct scsi_cmnd *))
1455 int request_id, retval;
1456 TW_Device_Extension *tw_dev = (TW_Device_Extension *)SCpnt->device->host->hostdata;
1458 /* If we are resetting due to timed out ioctl, report as busy */
1459 if (test_bit(TW_IN_RESET, &tw_dev->flags)) {
1460 retval = SCSI_MLQUEUE_HOST_BUSY;
1464 /* Save done function into scsi_cmnd struct */
1465 SCpnt->scsi_done = done;
1467 /* Get a free request id */
1468 twl_get_request_id(tw_dev, &request_id);
1470 /* Save the scsi command for use by the ISR */
1471 tw_dev->srb[request_id] = SCpnt;
1473 retval = twl_scsiop_execute_scsi(tw_dev, request_id, NULL, 0, NULL);
1475 tw_dev->state[request_id] = TW_S_COMPLETED;
1476 twl_free_request_id(tw_dev, request_id);
1477 SCpnt->result = (DID_ERROR << 16);
1483 } /* End twl_scsi_queue() */
1485 static DEF_SCSI_QCMD(twl_scsi_queue)
1487 /* This function tells the controller to shut down */
1488 static void __twl_shutdown(TW_Device_Extension *tw_dev)
1490 /* Disable interrupts */
1491 TWL_MASK_INTERRUPTS(tw_dev);
1493 /* Free up the IRQ */
1494 free_irq(tw_dev->tw_pci_dev->irq, tw_dev);
1496 printk(KERN_WARNING "3w-sas: Shutting down host %d.\n", tw_dev->host->host_no);
1498 /* Tell the card we are shutting down */
1499 if (twl_initconnection(tw_dev, 1, 0, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL)) {
1500 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x16, "Connection shutdown failed");
1502 printk(KERN_WARNING "3w-sas: Shutdown complete.\n");
1505 /* Clear doorbell interrupt just before exit */
1506 TWL_CLEAR_DB_INTERRUPT(tw_dev);
1507 } /* End __twl_shutdown() */
1509 /* Wrapper for __twl_shutdown */
1510 static void twl_shutdown(struct pci_dev *pdev)
1512 struct Scsi_Host *host = pci_get_drvdata(pdev);
1513 TW_Device_Extension *tw_dev;
1518 tw_dev = (TW_Device_Extension *)host->hostdata;
1521 __twl_shutdown(tw_dev);
1522 } /* End twl_shutdown() */
1524 /* This function configures unit settings when a unit is coming on-line */
1525 static int twl_slave_configure(struct scsi_device *sdev)
1527 /* Force 60 second timeout */
1528 blk_queue_rq_timeout(sdev->request_queue, 60 * HZ);
1531 } /* End twl_slave_configure() */
1533 /* scsi_host_template initializer */
1534 static struct scsi_host_template driver_template = {
1535 .module = THIS_MODULE,
1537 .queuecommand = twl_scsi_queue,
1538 .eh_host_reset_handler = twl_scsi_eh_reset,
1539 .bios_param = twl_scsi_biosparam,
1540 .change_queue_depth = scsi_change_queue_depth,
1541 .can_queue = TW_Q_LENGTH-2,
1542 .slave_configure = twl_slave_configure,
1544 .sg_tablesize = TW_LIBERATOR_MAX_SGL_LENGTH,
1545 .max_sectors = TW_MAX_SECTORS,
1546 .cmd_per_lun = TW_MAX_CMDS_PER_LUN,
1547 .shost_attrs = twl_host_attrs,
1552 /* This function will probe and initialize a card */
1553 static int twl_probe(struct pci_dev *pdev, const struct pci_device_id *dev_id)
1555 struct Scsi_Host *host = NULL;
1556 TW_Device_Extension *tw_dev;
1557 int retval = -ENODEV;
1558 int *ptr_phycount, phycount=0;
1560 retval = pci_enable_device(pdev);
1562 TW_PRINTK(host, TW_DRIVER, 0x17, "Failed to enable pci device");
1563 goto out_disable_device;
1566 pci_set_master(pdev);
1567 pci_try_set_mwi(pdev);
1569 retval = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
1571 retval = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
1573 TW_PRINTK(host, TW_DRIVER, 0x18, "Failed to set dma mask");
1575 goto out_disable_device;
1578 host = scsi_host_alloc(&driver_template, sizeof(TW_Device_Extension));
1580 TW_PRINTK(host, TW_DRIVER, 0x19, "Failed to allocate memory for device extension");
1582 goto out_disable_device;
1584 tw_dev = shost_priv(host);
1586 /* Save values to device extension */
1587 tw_dev->host = host;
1588 tw_dev->tw_pci_dev = pdev;
1590 if (twl_initialize_device_extension(tw_dev)) {
1591 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1a, "Failed to initialize device extension");
1593 goto out_free_device_extension;
1596 /* Request IO regions */
1597 retval = pci_request_regions(pdev, "3w-sas");
1599 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1b, "Failed to get mem region");
1600 goto out_free_device_extension;
1603 /* Save base address, use region 1 */
1604 tw_dev->base_addr = pci_iomap(pdev, 1, 0);
1605 if (!tw_dev->base_addr) {
1606 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1c, "Failed to ioremap");
1608 goto out_release_mem_region;
1611 /* Disable interrupts on the card */
1612 TWL_MASK_INTERRUPTS(tw_dev);
1614 /* Initialize the card */
1615 if (twl_reset_sequence(tw_dev, 0)) {
1616 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1d, "Controller reset failed during probe");
1621 /* Set host specific parameters */
1622 host->max_id = TW_MAX_UNITS;
1623 host->max_cmd_len = TW_MAX_CDB_LEN;
1624 host->max_lun = TW_MAX_LUNS;
1625 host->max_channel = 0;
1627 /* Register the card with the kernel SCSI layer */
1628 retval = scsi_add_host(host, &pdev->dev);
1630 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1e, "scsi add host failed");
1634 pci_set_drvdata(pdev, host);
1636 printk(KERN_WARNING "3w-sas: scsi%d: Found an LSI 3ware %s Controller at 0x%llx, IRQ: %d.\n",
1638 (char *)twl_get_param(tw_dev, 1, TW_VERSION_TABLE,
1639 TW_PARAM_MODEL, TW_PARAM_MODEL_LENGTH),
1640 (u64)pci_resource_start(pdev, 1), pdev->irq);
1642 ptr_phycount = twl_get_param(tw_dev, 2, TW_PARAM_PHY_SUMMARY_TABLE,
1643 TW_PARAM_PHYCOUNT, TW_PARAM_PHYCOUNT_LENGTH);
1645 phycount = le32_to_cpu(*(int *)ptr_phycount);
1647 printk(KERN_WARNING "3w-sas: scsi%d: Firmware %s, BIOS %s, Phys: %d.\n",
1649 (char *)twl_get_param(tw_dev, 1, TW_VERSION_TABLE,
1650 TW_PARAM_FWVER, TW_PARAM_FWVER_LENGTH),
1651 (char *)twl_get_param(tw_dev, 2, TW_VERSION_TABLE,
1652 TW_PARAM_BIOSVER, TW_PARAM_BIOSVER_LENGTH),
1655 /* Try to enable MSI */
1656 if (use_msi && !pci_enable_msi(pdev))
1657 set_bit(TW_USING_MSI, &tw_dev->flags);
1659 /* Now setup the interrupt handler */
1660 retval = request_irq(pdev->irq, twl_interrupt, IRQF_SHARED, "3w-sas", tw_dev);
1662 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1f, "Error requesting IRQ");
1663 goto out_remove_host;
1666 twl_device_extension_list[twl_device_extension_count] = tw_dev;
1667 twl_device_extension_count++;
1669 /* Re-enable interrupts on the card */
1670 TWL_UNMASK_INTERRUPTS(tw_dev);
1672 /* Finally, scan the host */
1673 scsi_scan_host(host);
1675 /* Add sysfs binary files */
1676 if (sysfs_create_bin_file(&host->shost_dev.kobj, &twl_sysfs_aen_read_attr))
1677 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x20, "Failed to create sysfs binary file: 3ware_aen_read");
1678 if (sysfs_create_bin_file(&host->shost_dev.kobj, &twl_sysfs_compat_info_attr))
1679 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x21, "Failed to create sysfs binary file: 3ware_compat_info");
1681 if (twl_major == -1) {
1682 if ((twl_major = register_chrdev (0, "twl", &twl_fops)) < 0)
1683 TW_PRINTK(host, TW_DRIVER, 0x22, "Failed to register character device");
1689 if (test_bit(TW_USING_MSI, &tw_dev->flags))
1690 pci_disable_msi(pdev);
1691 scsi_remove_host(host);
1693 iounmap(tw_dev->base_addr);
1694 out_release_mem_region:
1695 pci_release_regions(pdev);
1696 out_free_device_extension:
1697 twl_free_device_extension(tw_dev);
1698 scsi_host_put(host);
1700 pci_disable_device(pdev);
1703 } /* End twl_probe() */
1705 /* This function is called to remove a device */
1706 static void twl_remove(struct pci_dev *pdev)
1708 struct Scsi_Host *host = pci_get_drvdata(pdev);
1709 TW_Device_Extension *tw_dev;
1714 tw_dev = (TW_Device_Extension *)host->hostdata;
1716 if (!tw_dev->online)
1719 /* Remove sysfs binary files */
1720 sysfs_remove_bin_file(&host->shost_dev.kobj, &twl_sysfs_aen_read_attr);
1721 sysfs_remove_bin_file(&host->shost_dev.kobj, &twl_sysfs_compat_info_attr);
1723 scsi_remove_host(tw_dev->host);
1725 /* Unregister character device */
1726 if (twl_major >= 0) {
1727 unregister_chrdev(twl_major, "twl");
1731 /* Shutdown the card */
1732 __twl_shutdown(tw_dev);
1734 /* Disable MSI if enabled */
1735 if (test_bit(TW_USING_MSI, &tw_dev->flags))
1736 pci_disable_msi(pdev);
1738 /* Free IO remapping */
1739 iounmap(tw_dev->base_addr);
1741 /* Free up the mem region */
1742 pci_release_regions(pdev);
1744 /* Free up device extension resources */
1745 twl_free_device_extension(tw_dev);
1747 scsi_host_put(tw_dev->host);
1748 pci_disable_device(pdev);
1749 twl_device_extension_count--;
1750 } /* End twl_remove() */
1752 /* This function is called on PCI suspend */
1753 static int __maybe_unused twl_suspend(struct device *dev)
1755 struct Scsi_Host *host = dev_get_drvdata(dev);
1756 TW_Device_Extension *tw_dev = (TW_Device_Extension *)host->hostdata;
1758 printk(KERN_WARNING "3w-sas: Suspending host %d.\n", tw_dev->host->host_no);
1759 /* Disable interrupts */
1760 TWL_MASK_INTERRUPTS(tw_dev);
1762 free_irq(tw_dev->tw_pci_dev->irq, tw_dev);
1764 /* Tell the card we are shutting down */
1765 if (twl_initconnection(tw_dev, 1, 0, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL)) {
1766 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x23, "Connection shutdown failed during suspend");
1768 printk(KERN_WARNING "3w-sas: Suspend complete.\n");
1771 /* Clear doorbell interrupt */
1772 TWL_CLEAR_DB_INTERRUPT(tw_dev);
1775 } /* End twl_suspend() */
1777 /* This function is called on PCI resume */
1778 static int __maybe_unused twl_resume(struct device *dev)
1781 struct pci_dev *pdev = to_pci_dev(dev);
1782 struct Scsi_Host *host = pci_get_drvdata(pdev);
1783 TW_Device_Extension *tw_dev = (TW_Device_Extension *)host->hostdata;
1785 printk(KERN_WARNING "3w-sas: Resuming host %d.\n", tw_dev->host->host_no);
1786 pci_try_set_mwi(pdev);
1788 retval = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
1790 retval = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
1792 TW_PRINTK(host, TW_DRIVER, 0x25, "Failed to set dma mask during resume");
1794 goto out_disable_device;
1797 /* Initialize the card */
1798 if (twl_reset_sequence(tw_dev, 0)) {
1800 goto out_disable_device;
1803 /* Now setup the interrupt handler */
1804 retval = request_irq(pdev->irq, twl_interrupt, IRQF_SHARED, "3w-sas", tw_dev);
1806 TW_PRINTK(tw_dev->host, TW_DRIVER, 0x26, "Error requesting IRQ during resume");
1808 goto out_disable_device;
1811 /* Now enable MSI if enabled */
1812 if (test_bit(TW_USING_MSI, &tw_dev->flags))
1813 pci_enable_msi(pdev);
1815 /* Re-enable interrupts on the card */
1816 TWL_UNMASK_INTERRUPTS(tw_dev);
1818 printk(KERN_WARNING "3w-sas: Resume complete.\n");
1822 scsi_remove_host(host);
1825 } /* End twl_resume() */
1827 /* PCI Devices supported by this driver */
1828 static struct pci_device_id twl_pci_tbl[] = {
1829 { PCI_VDEVICE(3WARE, PCI_DEVICE_ID_3WARE_9750) },
1832 MODULE_DEVICE_TABLE(pci, twl_pci_tbl);
1834 static SIMPLE_DEV_PM_OPS(twl_pm_ops, twl_suspend, twl_resume);
1836 /* pci_driver initializer */
1837 static struct pci_driver twl_driver = {
1839 .id_table = twl_pci_tbl,
1841 .remove = twl_remove,
1842 .driver.pm = &twl_pm_ops,
1843 .shutdown = twl_shutdown
1846 /* This function is called on driver initialization */
1847 static int __init twl_init(void)
1849 printk(KERN_INFO "LSI 3ware SAS/SATA-RAID Controller device driver for Linux v%s.\n", TW_DRIVER_VERSION);
1851 return pci_register_driver(&twl_driver);
1852 } /* End twl_init() */
1854 /* This function is called on driver exit */
1855 static void __exit twl_exit(void)
1857 pci_unregister_driver(&twl_driver);
1858 } /* End twl_exit() */
1860 module_init(twl_init);
1861 module_exit(twl_exit);