2 * QLogic iSCSI HBA Driver
3 * Copyright (c) 2003-2006 QLogic Corporation
5 * See LICENSE.qla4xxx for copyright and licensing details.
11 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/types.h>
14 #include <linux/module.h>
15 #include <linux/list.h>
16 #include <linux/pci.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/dmapool.h>
21 #include <linux/mempool.h>
22 #include <linux/spinlock.h>
23 #include <linux/workqueue.h>
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/mutex.h>
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_host.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <scsi/scsi_transport.h>
34 #include <scsi/scsi_transport_iscsi.h>
37 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4010
38 #define PCI_DEVICE_ID_QLOGIC_ISP4010 0x4010
41 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4022
42 #define PCI_DEVICE_ID_QLOGIC_ISP4022 0x4022
49 * Data bit definitions
67 #define BIT_16 0x10000
68 #define BIT_17 0x20000
69 #define BIT_18 0x40000
70 #define BIT_19 0x80000
71 #define BIT_20 0x100000
72 #define BIT_21 0x200000
73 #define BIT_22 0x400000
74 #define BIT_23 0x800000
75 #define BIT_24 0x1000000
76 #define BIT_25 0x2000000
77 #define BIT_26 0x4000000
78 #define BIT_27 0x8000000
79 #define BIT_28 0x10000000
80 #define BIT_29 0x20000000
81 #define BIT_30 0x40000000
82 #define BIT_31 0x80000000
85 * Host adapter default definitions
86 ***********************************/
89 #define MAX_TARGETS (MAX_PRST_DEV_DB_ENTRIES + MAX_DEV_DB_ENTRIES)
90 #define MAX_LUNS 0xffff
91 #define MAX_AEN_ENTRIES 256 /* should be > EXT_DEF_MAX_AEN_QUEUE */
92 #define MAX_DDB_ENTRIES (MAX_PRST_DEV_DB_ENTRIES + MAX_DEV_DB_ENTRIES)
93 #define MAX_PDU_ENTRIES 32
94 #define INVALID_ENTRY 0xFFFF
95 #define MAX_CMDS_TO_RISC 1024
96 #define MAX_SRBS MAX_CMDS_TO_RISC
97 #define MBOX_AEN_REG_COUNT 5
98 #define MAX_INIT_RETRIES 5
99 #define IOCB_HIWAT_CUSHION 16
104 #define REQUEST_QUEUE_DEPTH MAX_CMDS_TO_RISC
105 #define RESPONSE_QUEUE_DEPTH 64
106 #define QUEUE_SIZE 64
107 #define DMA_BUFFER_SIZE 512
112 #define MAC_ADDR_LEN 6 /* in bytes */
113 #define IP_ADDR_LEN 4 /* in bytes */
114 #define DRIVER_NAME "qla4xxx"
116 #define MAX_LINKED_CMDS_PER_LUN 3
117 #define MAX_REQS_SERVICED_PER_INTR 16
119 #define ISCSI_IPADDR_SIZE 4 /* IP address size */
120 #define ISCSI_ALIAS_SIZE 32 /* ISCSI Alais name size */
121 #define ISCSI_NAME_SIZE 255 /* ISCSI Name size -
122 * usually a string */
124 #define LSDW(x) ((u32)((u64)(x)))
125 #define MSDW(x) ((u32)((((u64)(x)) >> 16) >> 16))
128 * Retry & Timeout Values
131 #define SOFT_RESET_TOV 30
132 #define RESET_INTR_TOV 3
133 #define SEMAPHORE_TOV 10
134 #define ADAPTER_INIT_TOV 120
135 #define ADAPTER_RESET_TOV 180
136 #define EXTEND_CMD_TOV 60
137 #define WAIT_CMD_TOV 30
138 #define EH_WAIT_CMD_TOV 120
139 #define FIRMWARE_UP_TOV 60
140 #define RESET_FIRMWARE_TOV 30
141 #define LOGOUT_TOV 10
142 #define IOCB_TOV_MARGIN 10
143 #define RELOGIN_TOV 18
144 #define ISNS_DEREG_TOV 5
146 #define MAX_RESET_HA_RETRIES 2
149 * SCSI Request Block structure (srb) that is placed
150 * on cmd->SCp location of every I/O [We have 22 bytes available]
153 struct list_head list; /* (8) */
154 struct scsi_qla_host *ha; /* HA the SP is queued on */
155 struct ddb_entry *ddb;
156 uint16_t flags; /* (1) Status flags. */
158 #define SRB_DMA_VALID BIT_3 /* DMA Buffer mapped. */
159 #define SRB_GOT_SENSE BIT_4 /* sense data recieved. */
160 uint8_t state; /* (1) Status flags. */
162 #define SRB_NO_QUEUE_STATE 0 /* Request is in between states */
163 #define SRB_FREE_STATE 1
164 #define SRB_ACTIVE_STATE 3
165 #define SRB_ACTIVE_TIMEOUT_STATE 4
166 #define SRB_SUSPENDED_STATE 7 /* Request in suspended state */
168 struct scsi_cmnd *cmd; /* (4) SCSI command block */
169 dma_addr_t dma_handle; /* (4) for unmap of single transfers */
170 atomic_t ref_count; /* reference count for this srb */
171 uint32_t fw_ddb_index;
172 uint8_t err_id; /* error id */
173 #define SRB_ERR_PORT 1 /* Request failed because "port down" */
174 #define SRB_ERR_LOOP 2 /* Request failed because "loop down" */
175 #define SRB_ERR_DEVICE 3 /* Request failed because "device error" */
176 #define SRB_ERR_OTHER 4
180 uint16_t iocb_cnt; /* Number of used iocbs */
182 u_long r_start; /* Time we recieve a cmd from OS */
183 u_long u_start; /* Time when we handed the cmd to F/W */
187 * Device Database (DDB) structure
190 struct list_head list; /* ddb list */
191 struct scsi_qla_host *ha;
192 struct iscsi_cls_session *sess;
193 struct iscsi_cls_conn *conn;
195 atomic_t state; /* DDB State */
197 unsigned long flags; /* DDB Flags */
199 unsigned long dev_scan_wait_to_start_relogin;
200 unsigned long dev_scan_wait_to_complete_relogin;
202 uint16_t os_target_id; /* Target ID */
203 uint16_t fw_ddb_index; /* DDB firmware index */
205 uint32_t fw_ddb_device_state; /* F/W Device State -- see ql4_fw.h */
208 uint16_t target_session_id;
209 uint16_t connection_id;
210 uint16_t exe_throttle; /* Max mumber of cmds outstanding
212 uint16_t task_mgmt_timeout; /* Min time for task mgmt cmds to
214 uint16_t default_relogin_timeout; /* Max time to wait for
215 * relogin to complete */
216 uint16_t tcp_source_port_num;
217 uint32_t default_time2wait; /* Default Min time between
218 * relogins (+aens) */
220 atomic_t port_down_timer; /* Device connection timer */
221 atomic_t retry_relogin_timer; /* Min Time between relogins
223 atomic_t relogin_timer; /* Max Time to wait for relogin to complete */
224 atomic_t relogin_retry_count; /* Num of times relogin has been
229 uint8_t ip_addr[ISCSI_IPADDR_SIZE];
230 uint8_t iscsi_name[ISCSI_NAME_SIZE]; /* 72 x48 */
231 uint8_t iscsi_alias[0x20];
237 #define DDB_STATE_DEAD 0 /* We can no longer talk to
239 #define DDB_STATE_ONLINE 1 /* Device ready to accept
241 #define DDB_STATE_MISSING 2 /* Device logged off, trying
247 #define DF_RELOGIN 0 /* Relogin to device */
248 #define DF_NO_RELOGIN 1 /* Do not relogin if IOCTL
250 #define DF_ISNS_DISCOVERED 2 /* Device was discovered via iSNS */
251 #define DF_FO_MASKED 3
254 * Asynchronous Event Queue structure
257 uint32_t mbox_sts[MBOX_AEN_REG_COUNT];
262 #include "ql4_nvram.h"
265 * Linux Host Adapter structure
267 struct scsi_qla_host {
268 /* Linux adapter configuration data */
269 struct Scsi_Host *host; /* pointer to host data */
273 #define AF_ONLINE 0 /* 0x00000001 */
274 #define AF_INIT_DONE 1 /* 0x00000002 */
275 #define AF_MBOX_COMMAND 2 /* 0x00000004 */
276 #define AF_MBOX_COMMAND_DONE 3 /* 0x00000008 */
277 #define AF_INTERRUPTS_ON 6 /* 0x00000040 Not Used */
278 #define AF_GET_CRASH_RECORD 7 /* 0x00000080 */
279 #define AF_LINK_UP 8 /* 0x00000100 */
280 #define AF_TOPCAT_CHIP_PRESENT 9 /* 0x00000200 */
281 #define AF_IRQ_ATTACHED 10 /* 0x00000400 */
282 #define AF_ISNS_CMD_IN_PROCESS 12 /* 0x00001000 */
283 #define AF_ISNS_CMD_DONE 13 /* 0x00002000 */
285 unsigned long dpc_flags;
287 #define DPC_RESET_HA 1 /* 0x00000002 */
288 #define DPC_RETRY_RESET_HA 2 /* 0x00000004 */
289 #define DPC_RELOGIN_DEVICE 3 /* 0x00000008 */
290 #define DPC_RESET_HA_DESTROY_DDB_LIST 4 /* 0x00000010 */
291 #define DPC_RESET_HA_INTR 5 /* 0x00000020 */
292 #define DPC_ISNS_RESTART 7 /* 0x00000080 */
293 #define DPC_AEN 9 /* 0x00000200 */
294 #define DPC_GET_DHCP_IP_ADDR 15 /* 0x00008000 */
300 #define SRB_MIN_REQ 128
301 mempool_t *srb_mempool;
303 /* pci information */
304 struct pci_dev *pdev;
306 struct isp_reg __iomem *reg; /* Base I/O address */
307 unsigned long pio_address;
308 unsigned long pio_length;
309 #define MIN_IOBASE_LEN 0x100
311 uint16_t req_q_count;
312 uint8_t marker_needed;
315 unsigned long host_no;
317 /* NVRAM registers */
318 struct eeprom_data *nvram;
319 spinlock_t hardware_lock ____cacheline_aligned;
320 spinlock_t list_lock;
321 uint32_t eeprom_cmd_data;
323 /* Counters for general statistics */
324 uint64_t adapter_error_count;
325 uint64_t device_error_count;
326 uint64_t total_io_count;
327 uint64_t total_mbytes_xferred;
328 uint64_t link_failure_count;
329 uint64_t invalid_crc_count;
330 uint32_t spurious_int_count;
331 uint32_t aborted_io_count;
332 uint32_t io_timeout_count;
333 uint32_t mailbox_timeout_count;
334 uint32_t seconds_since_last_intr;
335 uint32_t seconds_since_last_heartbeat;
338 /* Info Needed for Management App */
339 /* --- From GetFwVersion --- */
340 uint32_t firmware_version[2];
341 uint32_t patch_number;
342 uint32_t build_number;
344 /* --- From Init_FW --- */
345 /* init_cb_t *init_cb; */
346 uint16_t firmware_options;
347 uint16_t tcp_options;
348 uint8_t ip_address[IP_ADDR_LEN];
349 uint8_t subnet_mask[IP_ADDR_LEN];
350 uint8_t gateway[IP_ADDR_LEN];
352 uint8_t name_string[256];
353 uint8_t heartbeat_interval;
356 /* --- From FlashSysInfo --- */
357 uint8_t my_mac[MAC_ADDR_LEN];
358 uint8_t serial_number[16];
360 /* --- From GetFwState --- */
361 uint32_t firmware_state;
363 uint32_t addl_fw_state;
365 /* Linux kernel thread */
366 struct workqueue_struct *dpc_thread;
367 struct work_struct dpc_work;
369 /* Linux timer thread */
370 struct timer_list timer;
371 uint32_t timer_active;
373 /* Recovery Timers */
374 uint32_t port_down_retry_count;
375 uint32_t discovery_wait;
376 atomic_t check_relogin_timeouts;
377 uint32_t retry_reset_ha_cnt;
378 uint32_t isp_reset_timer; /* reset test timer */
379 uint32_t nic_reset_timer; /* simulated nic reset test timer */
381 struct list_head free_srb_q;
382 uint16_t free_srb_q_count;
383 uint16_t num_srbs_allocated;
385 /* DMA Memory Block */
387 dma_addr_t queues_dma;
388 unsigned long queues_len;
390 #define MEM_ALIGN_VALUE \
391 ((max(REQUEST_QUEUE_DEPTH, RESPONSE_QUEUE_DEPTH)) * \
392 sizeof(struct queue_entry))
393 /* request and response queue variables */
394 dma_addr_t request_dma;
395 struct queue_entry *request_ring;
396 struct queue_entry *request_ptr;
397 dma_addr_t response_dma;
398 struct queue_entry *response_ring;
399 struct queue_entry *response_ptr;
400 dma_addr_t shadow_regs_dma;
401 struct shadow_regs *shadow_regs;
402 uint16_t request_in; /* Current indexes. */
403 uint16_t request_out;
404 uint16_t response_in;
405 uint16_t response_out;
407 /* aen queue variables */
408 uint16_t aen_q_count; /* Number of available aen_q entries */
409 uint16_t aen_in; /* Current indexes */
411 struct aen aen_q[MAX_AEN_ENTRIES];
413 /* This mutex protects several threads to do mailbox commands
416 struct mutex mbox_sem;
417 wait_queue_head_t mailbox_wait_queue;
419 /* temporary mailbox status registers */
420 volatile uint8_t mbox_status_count;
421 volatile uint32_t mbox_status[MBOX_REG_COUNT];
423 /* local device database list (contains internal ddb entries) */
424 struct list_head ddb_list;
426 /* Map ddb_list entry by FW ddb index */
427 struct ddb_entry *fw_ddb_index_map[MAX_DDB_ENTRIES];
431 static inline int is_qla4010(struct scsi_qla_host *ha)
433 return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4010;
436 static inline int is_qla4022(struct scsi_qla_host *ha)
438 return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4022;
441 static inline int adapter_up(struct scsi_qla_host *ha)
443 return (test_bit(AF_ONLINE, &ha->flags) != 0) &&
444 (test_bit(AF_LINK_UP, &ha->flags) != 0);
447 static inline struct scsi_qla_host* to_qla_host(struct Scsi_Host *shost)
449 return (struct scsi_qla_host *)shost->hostdata;
452 static inline void __iomem* isp_semaphore(struct scsi_qla_host *ha)
454 return (is_qla4022(ha) ?
455 &ha->reg->u1.isp4022.semaphore :
456 &ha->reg->u1.isp4010.nvram);
459 static inline void __iomem* isp_nvram(struct scsi_qla_host *ha)
461 return (is_qla4022(ha) ?
462 &ha->reg->u1.isp4022.nvram :
463 &ha->reg->u1.isp4010.nvram);
466 static inline void __iomem* isp_ext_hw_conf(struct scsi_qla_host *ha)
468 return (is_qla4022(ha) ?
469 &ha->reg->u2.isp4022.p0.ext_hw_conf :
470 &ha->reg->u2.isp4010.ext_hw_conf);
473 static inline void __iomem* isp_port_status(struct scsi_qla_host *ha)
475 return (is_qla4022(ha) ?
476 &ha->reg->u2.isp4022.p0.port_status :
477 &ha->reg->u2.isp4010.port_status);
480 static inline void __iomem* isp_port_ctrl(struct scsi_qla_host *ha)
482 return (is_qla4022(ha) ?
483 &ha->reg->u2.isp4022.p0.port_ctrl :
484 &ha->reg->u2.isp4010.port_ctrl);
487 static inline void __iomem* isp_port_error_status(struct scsi_qla_host *ha)
489 return (is_qla4022(ha) ?
490 &ha->reg->u2.isp4022.p0.port_err_status :
491 &ha->reg->u2.isp4010.port_err_status);
494 static inline void __iomem * isp_gp_out(struct scsi_qla_host *ha)
496 return (is_qla4022(ha) ?
497 &ha->reg->u2.isp4022.p0.gp_out :
498 &ha->reg->u2.isp4010.gp_out);
501 static inline int eeprom_ext_hw_conf_offset(struct scsi_qla_host *ha)
503 return (is_qla4022(ha) ?
504 offsetof(struct eeprom_data, isp4022.ext_hw_conf) / 2 :
505 offsetof(struct eeprom_data, isp4010.ext_hw_conf) / 2);
508 int ql4xxx_sem_spinlock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
509 void ql4xxx_sem_unlock(struct scsi_qla_host * ha, u32 sem_mask);
510 int ql4xxx_sem_lock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
512 static inline int ql4xxx_lock_flash(struct scsi_qla_host *a)
515 return ql4xxx_sem_spinlock(a, QL4022_FLASH_SEM_MASK,
516 (QL4022_RESOURCE_BITS_BASE_CODE |
517 (a->mac_index)) << 13);
519 return ql4xxx_sem_spinlock(a, QL4010_FLASH_SEM_MASK,
520 QL4010_FLASH_SEM_BITS);
523 static inline void ql4xxx_unlock_flash(struct scsi_qla_host *a)
526 ql4xxx_sem_unlock(a, QL4022_FLASH_SEM_MASK);
528 ql4xxx_sem_unlock(a, QL4010_FLASH_SEM_MASK);
531 static inline int ql4xxx_lock_nvram(struct scsi_qla_host *a)
534 return ql4xxx_sem_spinlock(a, QL4022_NVRAM_SEM_MASK,
535 (QL4022_RESOURCE_BITS_BASE_CODE |
536 (a->mac_index)) << 10);
538 return ql4xxx_sem_spinlock(a, QL4010_NVRAM_SEM_MASK,
539 QL4010_NVRAM_SEM_BITS);
542 static inline void ql4xxx_unlock_nvram(struct scsi_qla_host *a)
545 ql4xxx_sem_unlock(a, QL4022_NVRAM_SEM_MASK);
547 ql4xxx_sem_unlock(a, QL4010_NVRAM_SEM_MASK);
550 static inline int ql4xxx_lock_drvr(struct scsi_qla_host *a)
553 return ql4xxx_sem_lock(a, QL4022_DRVR_SEM_MASK,
554 (QL4022_RESOURCE_BITS_BASE_CODE |
555 (a->mac_index)) << 1);
557 return ql4xxx_sem_lock(a, QL4010_DRVR_SEM_MASK,
558 QL4010_DRVR_SEM_BITS);
561 static inline void ql4xxx_unlock_drvr(struct scsi_qla_host *a)
564 ql4xxx_sem_unlock(a, QL4022_DRVR_SEM_MASK);
566 ql4xxx_sem_unlock(a, QL4010_DRVR_SEM_MASK);
569 /*---------------------------------------------------------------------------*/
571 /* Defines for qla4xxx_initialize_adapter() and qla4xxx_recover_adapter() */
572 #define PRESERVE_DDB_LIST 0
573 #define REBUILD_DDB_LIST 1
575 /* Defines for process_aen() */
576 #define PROCESS_ALL_AENS 0
577 #define FLUSH_DDB_CHANGED_AENS 1
578 #define RELOGIN_DDB_CHANGED_AENS 2
580 #include "ql4_version.h"
581 #include "ql4_glbl.h"
583 #include "ql4_inline.h"
586 #endif /*_QLA4XXX_H */