Merge branch 'fix/hda' into topic/hda
[linux-2.6] / drivers / scsi / qla4xxx / ql4_def.h
1 /*
2  * QLogic iSCSI HBA Driver
3  * Copyright (c)  2003-2006 QLogic Corporation
4  *
5  * See LICENSE.qla4xxx for copyright and licensing details.
6  */
7
8 #ifndef __QL4_DEF_H
9 #define __QL4_DEF_H
10
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>
27
28 #include <net/tcp.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>
35
36
37 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4010
38 #define PCI_DEVICE_ID_QLOGIC_ISP4010    0x4010
39 #endif
40
41 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4022
42 #define PCI_DEVICE_ID_QLOGIC_ISP4022    0x4022
43 #endif
44
45 #ifndef PCI_DEVICE_ID_QLOGIC_ISP4032
46 #define PCI_DEVICE_ID_QLOGIC_ISP4032    0x4032
47 #endif
48
49 #define QLA_SUCCESS                     0
50 #define QLA_ERROR                       1
51
52 /*
53  * Data bit definitions
54  */
55 #define BIT_0   0x1
56 #define BIT_1   0x2
57 #define BIT_2   0x4
58 #define BIT_3   0x8
59 #define BIT_4   0x10
60 #define BIT_5   0x20
61 #define BIT_6   0x40
62 #define BIT_7   0x80
63 #define BIT_8   0x100
64 #define BIT_9   0x200
65 #define BIT_10  0x400
66 #define BIT_11  0x800
67 #define BIT_12  0x1000
68 #define BIT_13  0x2000
69 #define BIT_14  0x4000
70 #define BIT_15  0x8000
71 #define BIT_16  0x10000
72 #define BIT_17  0x20000
73 #define BIT_18  0x40000
74 #define BIT_19  0x80000
75 #define BIT_20  0x100000
76 #define BIT_21  0x200000
77 #define BIT_22  0x400000
78 #define BIT_23  0x800000
79 #define BIT_24  0x1000000
80 #define BIT_25  0x2000000
81 #define BIT_26  0x4000000
82 #define BIT_27  0x8000000
83 #define BIT_28  0x10000000
84 #define BIT_29  0x20000000
85 #define BIT_30  0x40000000
86 #define BIT_31  0x80000000
87
88 /*
89  * Host adapter default definitions
90  ***********************************/
91 #define MAX_HBAS                16
92 #define MAX_BUSES               1
93 #define MAX_TARGETS             (MAX_PRST_DEV_DB_ENTRIES +  MAX_DEV_DB_ENTRIES)
94 #define MAX_LUNS                0xffff
95 #define MAX_AEN_ENTRIES         256 /* should be > EXT_DEF_MAX_AEN_QUEUE */
96 #define MAX_DDB_ENTRIES         (MAX_PRST_DEV_DB_ENTRIES + MAX_DEV_DB_ENTRIES)
97 #define MAX_PDU_ENTRIES         32
98 #define INVALID_ENTRY           0xFFFF
99 #define MAX_CMDS_TO_RISC        1024
100 #define MAX_SRBS                MAX_CMDS_TO_RISC
101 #define MBOX_AEN_REG_COUNT      5
102 #define MAX_INIT_RETRIES        5
103 #define IOCB_HIWAT_CUSHION      16
104
105 /*
106  * Buffer sizes
107  */
108 #define REQUEST_QUEUE_DEPTH             MAX_CMDS_TO_RISC
109 #define RESPONSE_QUEUE_DEPTH            64
110 #define QUEUE_SIZE                      64
111 #define DMA_BUFFER_SIZE                 512
112
113 /*
114  * Misc
115  */
116 #define MAC_ADDR_LEN                    6       /* in bytes */
117 #define IP_ADDR_LEN                     4       /* in bytes */
118 #define DRIVER_NAME                     "qla4xxx"
119
120 #define MAX_LINKED_CMDS_PER_LUN         3
121 #define MAX_REQS_SERVICED_PER_INTR      16
122
123 #define ISCSI_IPADDR_SIZE               4       /* IP address size */
124 #define ISCSI_ALIAS_SIZE                32      /* ISCSI Alias name size */
125 #define ISCSI_NAME_SIZE                 0xE0    /* ISCSI Name size */
126
127 #define LSDW(x) ((u32)((u64)(x)))
128 #define MSDW(x) ((u32)((((u64)(x)) >> 16) >> 16))
129
130 /*
131  * Retry & Timeout Values
132  */
133 #define MBOX_TOV                        60
134 #define SOFT_RESET_TOV                  30
135 #define RESET_INTR_TOV                  3
136 #define SEMAPHORE_TOV                   10
137 #define ADAPTER_INIT_TOV                120
138 #define ADAPTER_RESET_TOV               180
139 #define EXTEND_CMD_TOV                  60
140 #define WAIT_CMD_TOV                    30
141 #define EH_WAIT_CMD_TOV                 120
142 #define FIRMWARE_UP_TOV                 60
143 #define RESET_FIRMWARE_TOV              30
144 #define LOGOUT_TOV                      10
145 #define IOCB_TOV_MARGIN                 10
146 #define RELOGIN_TOV                     18
147 #define ISNS_DEREG_TOV                  5
148
149 #define MAX_RESET_HA_RETRIES            2
150
151 /*
152  * SCSI Request Block structure  (srb)  that is placed
153  * on cmd->SCp location of every I/O     [We have 22 bytes available]
154  */
155 struct srb {
156         struct list_head list;  /* (8)   */
157         struct scsi_qla_host *ha;       /* HA the SP is queued on */
158         struct ddb_entry        *ddb;
159         uint16_t flags;         /* (1) Status flags. */
160
161 #define SRB_DMA_VALID           BIT_3   /* DMA Buffer mapped. */
162 #define SRB_GOT_SENSE           BIT_4   /* sense data recieved. */
163         uint8_t state;          /* (1) Status flags. */
164
165 #define SRB_NO_QUEUE_STATE       0      /* Request is in between states */
166 #define SRB_FREE_STATE           1
167 #define SRB_ACTIVE_STATE         3
168 #define SRB_ACTIVE_TIMEOUT_STATE 4
169 #define SRB_SUSPENDED_STATE      7      /* Request in suspended state */
170
171         struct scsi_cmnd *cmd;  /* (4) SCSI command block */
172         dma_addr_t dma_handle;  /* (4) for unmap of single transfers */
173         atomic_t ref_count;     /* reference count for this srb */
174         uint32_t fw_ddb_index;
175         uint8_t err_id;         /* error id */
176 #define SRB_ERR_PORT       1    /* Request failed because "port down" */
177 #define SRB_ERR_LOOP       2    /* Request failed because "loop down" */
178 #define SRB_ERR_DEVICE     3    /* Request failed because "device error" */
179 #define SRB_ERR_OTHER      4
180
181         uint16_t reserved;
182         uint16_t iocb_tov;
183         uint16_t iocb_cnt;      /* Number of used iocbs */
184         uint16_t cc_stat;
185         u_long r_start;         /* Time we recieve a cmd from OS */
186         u_long u_start;         /* Time when we handed the cmd to F/W */
187 };
188
189 /*
190  * Asynchronous Event Queue structure
191  */
192 struct aen {
193         uint32_t mbox_sts[MBOX_AEN_REG_COUNT];
194 };
195
196 struct ql4_aen_log {
197         int count;
198         struct aen entry[MAX_AEN_ENTRIES];
199 };
200
201 /*
202  * Device Database (DDB) structure
203  */
204 struct ddb_entry {
205         struct list_head list;  /* ddb list */
206         struct scsi_qla_host *ha;
207         struct iscsi_cls_session *sess;
208         struct iscsi_cls_conn *conn;
209
210         atomic_t state;         /* DDB State */
211
212         unsigned long flags;    /* DDB Flags */
213
214         unsigned long dev_scan_wait_to_start_relogin;
215         unsigned long dev_scan_wait_to_complete_relogin;
216
217         uint16_t os_target_id;  /* Target ID */
218         uint16_t fw_ddb_index;  /* DDB firmware index */
219         uint8_t reserved[2];
220         uint32_t fw_ddb_device_state; /* F/W Device State  -- see ql4_fw.h */
221
222         uint32_t CmdSn;
223         uint16_t target_session_id;
224         uint16_t connection_id;
225         uint16_t exe_throttle;  /* Max mumber of cmds outstanding
226                                  * simultaneously */
227         uint16_t task_mgmt_timeout; /* Min time for task mgmt cmds to
228                                      * complete */
229         uint16_t default_relogin_timeout; /*  Max time to wait for
230                                            *  relogin to complete */
231         uint16_t tcp_source_port_num;
232         uint32_t default_time2wait; /* Default Min time between
233                                      * relogins (+aens) */
234
235         atomic_t port_down_timer; /* Device connection timer */
236         atomic_t retry_relogin_timer; /* Min Time between relogins
237                                        * (4000 only) */
238         atomic_t relogin_timer; /* Max Time to wait for relogin to complete */
239         atomic_t relogin_retry_count; /* Num of times relogin has been
240                                        * retried */
241
242         uint16_t port;
243         uint32_t tpgt;
244         uint8_t ip_addr[ISCSI_IPADDR_SIZE];
245         uint8_t iscsi_name[ISCSI_NAME_SIZE];    /* 72 x48 */
246         uint8_t iscsi_alias[0x20];
247         uint8_t isid[6];
248 };
249
250 /*
251  * DDB states.
252  */
253 #define DDB_STATE_DEAD          0       /* We can no longer talk to
254                                          * this device */
255 #define DDB_STATE_ONLINE        1       /* Device ready to accept
256                                          * commands */
257 #define DDB_STATE_MISSING       2       /* Device logged off, trying
258                                          * to re-login */
259
260 /*
261  * DDB flags.
262  */
263 #define DF_RELOGIN              0       /* Relogin to device */
264 #define DF_NO_RELOGIN           1       /* Do not relogin if IOCTL
265                                          * logged it out */
266 #define DF_ISNS_DISCOVERED      2       /* Device was discovered via iSNS */
267 #define DF_FO_MASKED            3
268
269
270 #include "ql4_fw.h"
271 #include "ql4_nvram.h"
272
273 /*
274  * Linux Host Adapter structure
275  */
276 struct scsi_qla_host {
277         /* Linux adapter configuration data */
278         unsigned long flags;
279
280 #define AF_ONLINE                       0 /* 0x00000001 */
281 #define AF_INIT_DONE                    1 /* 0x00000002 */
282 #define AF_MBOX_COMMAND                 2 /* 0x00000004 */
283 #define AF_MBOX_COMMAND_DONE            3 /* 0x00000008 */
284 #define AF_INTERRUPTS_ON                6 /* 0x00000040 */
285 #define AF_GET_CRASH_RECORD             7 /* 0x00000080 */
286 #define AF_LINK_UP                      8 /* 0x00000100 */
287 #define AF_IRQ_ATTACHED                 10 /* 0x00000400 */
288 #define AF_DISABLE_ACB_COMPLETE         11 /* 0x00000800 */
289
290         unsigned long dpc_flags;
291
292 #define DPC_RESET_HA                    1 /* 0x00000002 */
293 #define DPC_RETRY_RESET_HA              2 /* 0x00000004 */
294 #define DPC_RELOGIN_DEVICE              3 /* 0x00000008 */
295 #define DPC_RESET_HA_DESTROY_DDB_LIST   4 /* 0x00000010 */
296 #define DPC_RESET_HA_INTR               5 /* 0x00000020 */
297 #define DPC_ISNS_RESTART                7 /* 0x00000080 */
298 #define DPC_AEN                         9 /* 0x00000200 */
299 #define DPC_GET_DHCP_IP_ADDR            15 /* 0x00008000 */
300
301         struct Scsi_Host *host; /* pointer to host data */
302         uint32_t tot_ddbs;
303
304         uint16_t        iocb_cnt;
305         uint16_t        iocb_hiwat;
306
307         /* SRB cache. */
308 #define SRB_MIN_REQ     128
309         mempool_t *srb_mempool;
310
311         /* pci information */
312         struct pci_dev *pdev;
313
314         struct isp_reg __iomem *reg; /* Base I/O address */
315         unsigned long pio_address;
316         unsigned long pio_length;
317 #define MIN_IOBASE_LEN          0x100
318
319         uint16_t req_q_count;
320         uint8_t marker_needed;
321         uint8_t rsvd1;
322
323         unsigned long host_no;
324
325         /* NVRAM registers */
326         struct eeprom_data *nvram;
327         spinlock_t hardware_lock ____cacheline_aligned;
328         uint32_t   eeprom_cmd_data;
329
330         /* Counters for general statistics */
331         uint64_t isr_count;
332         uint64_t adapter_error_count;
333         uint64_t device_error_count;
334         uint64_t total_io_count;
335         uint64_t total_mbytes_xferred;
336         uint64_t link_failure_count;
337         uint64_t invalid_crc_count;
338         uint32_t bytes_xfered;
339         uint32_t spurious_int_count;
340         uint32_t aborted_io_count;
341         uint32_t io_timeout_count;
342         uint32_t mailbox_timeout_count;
343         uint32_t seconds_since_last_intr;
344         uint32_t seconds_since_last_heartbeat;
345         uint32_t mac_index;
346
347         /* Info Needed for Management App */
348         /* --- From GetFwVersion --- */
349         uint32_t firmware_version[2];
350         uint32_t patch_number;
351         uint32_t build_number;
352         uint32_t board_id;
353
354         /* --- From Init_FW --- */
355         /* init_cb_t *init_cb; */
356         uint16_t firmware_options;
357         uint16_t tcp_options;
358         uint8_t ip_address[IP_ADDR_LEN];
359         uint8_t subnet_mask[IP_ADDR_LEN];
360         uint8_t gateway[IP_ADDR_LEN];
361         uint8_t alias[32];
362         uint8_t name_string[256];
363         uint8_t heartbeat_interval;
364         uint8_t rsvd;
365
366         /* --- From FlashSysInfo --- */
367         uint8_t my_mac[MAC_ADDR_LEN];
368         uint8_t serial_number[16];
369
370         /* --- From GetFwState --- */
371         uint32_t firmware_state;
372         uint32_t addl_fw_state;
373
374         /* Linux kernel thread */
375         struct workqueue_struct *dpc_thread;
376         struct work_struct dpc_work;
377
378         /* Linux timer thread */
379         struct timer_list timer;
380         uint32_t timer_active;
381
382         /* Recovery Timers */
383         uint32_t port_down_retry_count;
384         uint32_t discovery_wait;
385         atomic_t check_relogin_timeouts;
386         uint32_t retry_reset_ha_cnt;
387         uint32_t isp_reset_timer;       /* reset test timer */
388         uint32_t nic_reset_timer;       /* simulated nic reset test timer */
389         int eh_start;
390         struct list_head free_srb_q;
391         uint16_t free_srb_q_count;
392         uint16_t num_srbs_allocated;
393
394         /* DMA Memory Block */
395         void *queues;
396         dma_addr_t queues_dma;
397         unsigned long queues_len;
398
399 #define MEM_ALIGN_VALUE \
400             ((max(REQUEST_QUEUE_DEPTH, RESPONSE_QUEUE_DEPTH)) * \
401              sizeof(struct queue_entry))
402         /* request and response queue variables */
403         dma_addr_t request_dma;
404         struct queue_entry *request_ring;
405         struct queue_entry *request_ptr;
406         dma_addr_t response_dma;
407         struct queue_entry *response_ring;
408         struct queue_entry *response_ptr;
409         dma_addr_t shadow_regs_dma;
410         struct shadow_regs *shadow_regs;
411         uint16_t request_in;    /* Current indexes. */
412         uint16_t request_out;
413         uint16_t response_in;
414         uint16_t response_out;
415
416         /* aen queue variables */
417         uint16_t aen_q_count;   /* Number of available aen_q entries */
418         uint16_t aen_in;        /* Current indexes */
419         uint16_t aen_out;
420         struct aen aen_q[MAX_AEN_ENTRIES];
421
422         struct ql4_aen_log aen_log;/* tracks all aens */
423
424         /* This mutex protects several threads to do mailbox commands
425          * concurrently.
426          */
427         struct mutex  mbox_sem;
428
429         /* temporary mailbox status registers */
430         volatile uint8_t mbox_status_count;
431         volatile uint32_t mbox_status[MBOX_REG_COUNT];
432
433         /* local device database list (contains internal ddb entries) */
434         struct list_head ddb_list;
435
436         /* Map ddb_list entry by FW ddb index */
437         struct ddb_entry *fw_ddb_index_map[MAX_DDB_ENTRIES];
438
439 };
440
441 static inline int is_qla4010(struct scsi_qla_host *ha)
442 {
443         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4010;
444 }
445
446 static inline int is_qla4022(struct scsi_qla_host *ha)
447 {
448         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4022;
449 }
450
451 static inline int is_qla4032(struct scsi_qla_host *ha)
452 {
453         return ha->pdev->device == PCI_DEVICE_ID_QLOGIC_ISP4032;
454 }
455
456 static inline int adapter_up(struct scsi_qla_host *ha)
457 {
458         return (test_bit(AF_ONLINE, &ha->flags) != 0) &&
459                 (test_bit(AF_LINK_UP, &ha->flags) != 0);
460 }
461
462 static inline struct scsi_qla_host* to_qla_host(struct Scsi_Host *shost)
463 {
464         return (struct scsi_qla_host *)shost->hostdata;
465 }
466
467 static inline void __iomem* isp_semaphore(struct scsi_qla_host *ha)
468 {
469         return (is_qla4010(ha) ?
470                 &ha->reg->u1.isp4010.nvram :
471                 &ha->reg->u1.isp4022.semaphore);
472 }
473
474 static inline void __iomem* isp_nvram(struct scsi_qla_host *ha)
475 {
476         return (is_qla4010(ha) ?
477                 &ha->reg->u1.isp4010.nvram :
478                 &ha->reg->u1.isp4022.nvram);
479 }
480
481 static inline void __iomem* isp_ext_hw_conf(struct scsi_qla_host *ha)
482 {
483         return (is_qla4010(ha) ?
484                 &ha->reg->u2.isp4010.ext_hw_conf :
485                 &ha->reg->u2.isp4022.p0.ext_hw_conf);
486 }
487
488 static inline void __iomem* isp_port_status(struct scsi_qla_host *ha)
489 {
490         return (is_qla4010(ha) ?
491                 &ha->reg->u2.isp4010.port_status :
492                 &ha->reg->u2.isp4022.p0.port_status);
493 }
494
495 static inline void __iomem* isp_port_ctrl(struct scsi_qla_host *ha)
496 {
497         return (is_qla4010(ha) ?
498                 &ha->reg->u2.isp4010.port_ctrl :
499                 &ha->reg->u2.isp4022.p0.port_ctrl);
500 }
501
502 static inline void __iomem* isp_port_error_status(struct scsi_qla_host *ha)
503 {
504         return (is_qla4010(ha) ?
505                 &ha->reg->u2.isp4010.port_err_status :
506                 &ha->reg->u2.isp4022.p0.port_err_status);
507 }
508
509 static inline void __iomem * isp_gp_out(struct scsi_qla_host *ha)
510 {
511         return (is_qla4010(ha) ?
512                 &ha->reg->u2.isp4010.gp_out :
513                 &ha->reg->u2.isp4022.p0.gp_out);
514 }
515
516 static inline int eeprom_ext_hw_conf_offset(struct scsi_qla_host *ha)
517 {
518         return (is_qla4010(ha) ?
519                 offsetof(struct eeprom_data, isp4010.ext_hw_conf) / 2 :
520                 offsetof(struct eeprom_data, isp4022.ext_hw_conf) / 2);
521 }
522
523 int ql4xxx_sem_spinlock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
524 void ql4xxx_sem_unlock(struct scsi_qla_host * ha, u32 sem_mask);
525 int ql4xxx_sem_lock(struct scsi_qla_host * ha, u32 sem_mask, u32 sem_bits);
526
527 static inline int ql4xxx_lock_flash(struct scsi_qla_host *a)
528 {
529         if (is_qla4010(a))
530                 return ql4xxx_sem_spinlock(a, QL4010_FLASH_SEM_MASK,
531                                            QL4010_FLASH_SEM_BITS);
532         else
533                 return ql4xxx_sem_spinlock(a, QL4022_FLASH_SEM_MASK,
534                                            (QL4022_RESOURCE_BITS_BASE_CODE |
535                                             (a->mac_index)) << 13);
536 }
537
538 static inline void ql4xxx_unlock_flash(struct scsi_qla_host *a)
539 {
540         if (is_qla4010(a))
541                 ql4xxx_sem_unlock(a, QL4010_FLASH_SEM_MASK);
542         else
543                 ql4xxx_sem_unlock(a, QL4022_FLASH_SEM_MASK);
544 }
545
546 static inline int ql4xxx_lock_nvram(struct scsi_qla_host *a)
547 {
548         if (is_qla4010(a))
549                 return ql4xxx_sem_spinlock(a, QL4010_NVRAM_SEM_MASK,
550                                            QL4010_NVRAM_SEM_BITS);
551         else
552                 return ql4xxx_sem_spinlock(a, QL4022_NVRAM_SEM_MASK,
553                                            (QL4022_RESOURCE_BITS_BASE_CODE |
554                                             (a->mac_index)) << 10);
555 }
556
557 static inline void ql4xxx_unlock_nvram(struct scsi_qla_host *a)
558 {
559         if (is_qla4010(a))
560                 ql4xxx_sem_unlock(a, QL4010_NVRAM_SEM_MASK);
561         else
562                 ql4xxx_sem_unlock(a, QL4022_NVRAM_SEM_MASK);
563 }
564
565 static inline int ql4xxx_lock_drvr(struct scsi_qla_host *a)
566 {
567         if (is_qla4010(a))
568                 return ql4xxx_sem_lock(a, QL4010_DRVR_SEM_MASK,
569                                        QL4010_DRVR_SEM_BITS);
570         else
571                 return ql4xxx_sem_lock(a, QL4022_DRVR_SEM_MASK,
572                                        (QL4022_RESOURCE_BITS_BASE_CODE |
573                                         (a->mac_index)) << 1);
574 }
575
576 static inline void ql4xxx_unlock_drvr(struct scsi_qla_host *a)
577 {
578         if (is_qla4010(a))
579                 ql4xxx_sem_unlock(a, QL4010_DRVR_SEM_MASK);
580         else
581                 ql4xxx_sem_unlock(a, QL4022_DRVR_SEM_MASK);
582 }
583
584 /*---------------------------------------------------------------------------*/
585
586 /* Defines for qla4xxx_initialize_adapter() and qla4xxx_recover_adapter() */
587 #define PRESERVE_DDB_LIST       0
588 #define REBUILD_DDB_LIST        1
589
590 /* Defines for process_aen() */
591 #define PROCESS_ALL_AENS         0
592 #define FLUSH_DDB_CHANGED_AENS   1
593 #define RELOGIN_DDB_CHANGED_AENS 2
594
595 #endif  /*_QLA4XXX_H */