[SCSI] lpfc 8.2.2 : Miscellaneous Bug Fixes
[linux-2.6.git] / drivers / scsi / lpfc / lpfc_sli.h
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2007 Emulex.  All rights reserved.           *
5  * EMULEX and SLI are trademarks of Emulex.                        *
6  * www.emulex.com                                                  *
7  *                                                                 *
8  * This program is free software; you can redistribute it and/or   *
9  * modify it under the terms of version 2 of the GNU General       *
10  * Public License as published by the Free Software Foundation.    *
11  * This program is distributed in the hope that it will be useful. *
12  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
13  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
14  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
15  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
16  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
17  * more details, a copy of which can be found in the file COPYING  *
18  * included with this package.                                     *
19  *******************************************************************/
20
21 /* forward declaration for LPFC_IOCB_t's use */
22 struct lpfc_hba;
23 struct lpfc_vport;
24
25 /* Define the context types that SLI handles for abort and sums. */
26 typedef enum _lpfc_ctx_cmd {
27         LPFC_CTX_LUN,
28         LPFC_CTX_TGT,
29         LPFC_CTX_HOST
30 } lpfc_ctx_cmd;
31
32 /* This structure is used to handle IOCB requests / responses */
33 struct lpfc_iocbq {
34         /* lpfc_iocbqs are used in double linked lists */
35         struct list_head list;
36         uint16_t iotag;         /* pre-assigned IO tag */
37         uint16_t rsvd1;
38
39         IOCB_t iocb;            /* IOCB cmd */
40         uint8_t retry;          /* retry counter for IOCB cmd - if needed */
41         uint8_t iocb_flag;
42 #define LPFC_IO_LIBDFC          1       /* libdfc iocb */
43 #define LPFC_IO_WAKE            2       /* High Priority Queue signal flag */
44 #define LPFC_IO_FCP             4       /* FCP command -- iocbq in scsi_buf */
45 #define LPFC_DRIVER_ABORTED     8       /* driver aborted this request */
46 #define LPFC_IO_FABRIC          0x10    /* Iocb send using fabric scheduler */
47
48         uint8_t abort_count;
49         uint8_t rsvd2;
50         uint32_t drvrTimeout;   /* driver timeout in seconds */
51         struct lpfc_vport *vport;/* virtual port pointer */
52         void *context1;         /* caller context information */
53         void *context2;         /* caller context information */
54         void *context3;         /* caller context information */
55         union {
56                 wait_queue_head_t    *wait_queue;
57                 struct lpfc_iocbq    *rsp_iocb;
58                 struct lpfcMboxq     *mbox;
59                 struct lpfc_nodelist *ndlp;
60         } context_un;
61
62         void (*fabric_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
63                            struct lpfc_iocbq *);
64         void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
65                            struct lpfc_iocbq *);
66
67 };
68
69 #define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
70
71 #define IOCB_SUCCESS        0
72 #define IOCB_BUSY           1
73 #define IOCB_ERROR          2
74 #define IOCB_TIMEDOUT       3
75
76 #define LPFC_MBX_WAKE           1
77 #define LPFC_MBX_IMED_UNREG     2
78
79 typedef struct lpfcMboxq {
80         /* MBOXQs are used in single linked lists */
81         struct list_head list;  /* ptr to next mailbox command */
82         MAILBOX_t mb;           /* Mailbox cmd */
83         struct lpfc_vport *vport;/* virutal port pointer */
84         void *context1;         /* caller context information */
85         void *context2;         /* caller context information */
86
87         void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
88         uint8_t mbox_flag;
89
90 } LPFC_MBOXQ_t;
91
92 #define MBX_POLL        1       /* poll mailbox till command done, then
93                                    return */
94 #define MBX_NOWAIT      2       /* issue command then return immediately */
95 #define MBX_STOP_IOCB   4       /* Stop iocb processing till mbox cmds
96                                    complete */
97
98 #define LPFC_MAX_RING_MASK  4   /* max num of rctl/type masks allowed per
99                                    ring */
100 #define LPFC_MAX_RING       4   /* max num of SLI rings used by driver */
101
102 struct lpfc_sli_ring;
103
104 struct lpfc_sli_ring_mask {
105         uint8_t profile;        /* profile associated with ring */
106         uint8_t rctl;   /* rctl / type pair configured for ring */
107         uint8_t type;   /* rctl / type pair configured for ring */
108         uint8_t rsvd;
109         /* rcv'd unsol event */
110         void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
111                                          struct lpfc_sli_ring *,
112                                          struct lpfc_iocbq *);
113 };
114
115
116 /* Structure used to hold SLI statistical counters and info */
117 struct lpfc_sli_ring_stat {
118         uint64_t iocb_event;     /* IOCB event counters */
119         uint64_t iocb_cmd;       /* IOCB cmd issued */
120         uint64_t iocb_rsp;       /* IOCB rsp received */
121         uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
122         uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
123         uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
124         uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
125 };
126
127 /* Structure used to hold SLI ring information */
128 struct lpfc_sli_ring {
129         uint16_t flag;          /* ring flags */
130 #define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
131 #define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
132 #define LPFC_STOP_IOCB_MBX       0x010  /* Stop processing IOCB cmds mbox */
133 #define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
134 #define LPFC_STOP_IOCB_MASK      0x030  /* Stop processing IOCB cmds mask */
135         uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
136
137         uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
138         uint32_t next_cmdidx;    /* next_cmd index */
139         uint32_t rspidx;        /* current index in response ring */
140         uint32_t cmdidx;        /* current index in command ring */
141         uint8_t rsvd;
142         uint8_t ringno;         /* ring number */
143         uint16_t numCiocb;      /* number of command iocb's per ring */
144         uint16_t numRiocb;      /* number of rsp iocb's per ring */
145         uint16_t sizeCiocb;     /* Size of command iocb's in this ring */
146         uint16_t sizeRiocb;     /* Size of response iocb's in this ring */
147
148         uint32_t fast_iotag;    /* max fastlookup based iotag           */
149         uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
150         uint32_t iotag_max;     /* max iotag value to use               */
151         struct list_head txq;
152         uint16_t txq_cnt;       /* current length of queue */
153         uint16_t txq_max;       /* max length */
154         struct list_head txcmplq;
155         uint16_t txcmplq_cnt;   /* current length of queue */
156         uint16_t txcmplq_max;   /* max length */
157         uint32_t *cmdringaddr;  /* virtual address for cmd rings */
158         uint32_t *rspringaddr;  /* virtual address for rsp rings */
159         uint32_t missbufcnt;    /* keep track of buffers to post */
160         struct list_head postbufq;
161         uint16_t postbufq_cnt;  /* current length of queue */
162         uint16_t postbufq_max;  /* max length */
163         struct list_head iocb_continueq;
164         uint16_t iocb_continueq_cnt;    /* current length of queue */
165         uint16_t iocb_continueq_max;    /* max length */
166
167         struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
168         uint32_t num_mask;      /* number of mask entries in prt array */
169
170         struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
171
172         /* cmd ring available */
173         void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
174                                         struct lpfc_sli_ring *);
175 };
176
177 /* Structure used for configuring rings to a specific profile or rctl / type */
178 struct lpfc_hbq_init {
179         uint32_t rn;            /* Receive buffer notification */
180         uint32_t entry_count;   /* max # of entries in HBQ */
181         uint32_t headerLen;     /* 0 if not profile 4 or 5 */
182         uint32_t logEntry;      /* Set to 1 if this HBQ used for LogEntry */
183         uint32_t profile;       /* Selection profile 0=all, 7=logentry */
184         uint32_t ring_mask;     /* Binds HBQ to a ring e.g. Ring0=b0001,
185                                  * ring2=b0100 */
186         uint32_t hbq_index;     /* index of this hbq in ring .HBQs[] */
187
188         uint32_t seqlenoff;
189         uint32_t maxlen;
190         uint32_t seqlenbcnt;
191         uint32_t cmdcodeoff;
192         uint32_t cmdmatch[8];
193         uint32_t mask_count;    /* number of mask entries in prt array */
194         struct hbq_mask hbqMasks[6];
195
196         /* Non-config rings fields to keep track of buffer allocations */
197         uint32_t buffer_count;  /* number of buffers allocated */
198         uint32_t init_count;    /* number to allocate when initialized */
199         uint32_t add_count;     /* number to allocate when starved */
200 } ;
201
202 #define LPFC_MAX_HBQ 16
203
204
205 /* Structure used to hold SLI statistical counters and info */
206 struct lpfc_sli_stat {
207         uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
208         uint64_t mbox_cmd;       /* Mailbox commands issued */
209         uint64_t sli_intr;       /* Count of Host Attention interrupts */
210         uint32_t err_attn_event; /* Error Attn event counters */
211         uint32_t link_event;     /* Link event counters */
212         uint32_t mbox_event;     /* Mailbox event counters */
213         uint32_t mbox_busy;      /* Mailbox cmd busy */
214 };
215
216 /* Structure to store link status values when port stats are reset */
217 struct lpfc_lnk_stat {
218         uint32_t link_failure_count;
219         uint32_t loss_of_sync_count;
220         uint32_t loss_of_signal_count;
221         uint32_t prim_seq_protocol_err_count;
222         uint32_t invalid_tx_word_count;
223         uint32_t invalid_crc_count;
224         uint32_t error_frames;
225         uint32_t link_events;
226 };
227
228 /* Structure used to hold SLI information */
229 struct lpfc_sli {
230         uint32_t num_rings;
231         uint32_t sli_flag;
232
233         /* Additional sli_flags */
234 #define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
235 #define LPFC_SLI2_ACTIVE          0x200 /* SLI2 overlay in firmware is active */
236 #define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
237 #define LPFC_BLOCK_MGMT_IO        0x800 /* Don't allow mgmt mbx or iocb cmds */
238
239         struct lpfc_sli_ring ring[LPFC_MAX_RING];
240         int fcp_ring;           /* ring used for FCP initiator commands */
241         int next_ring;
242
243         int extra_ring;         /* extra ring used for other protocols */
244
245         struct lpfc_sli_stat slistat;   /* SLI statistical info */
246         struct list_head mboxq;
247         uint16_t mboxq_cnt;     /* current length of queue */
248         uint16_t mboxq_max;     /* max length */
249         LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
250         struct list_head mboxq_cmpl;
251
252         struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
253                                            cmd */
254
255 #define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
256         struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
257         size_t iocbq_lookup_len;           /* current lengs of the array */
258         uint16_t  last_iotag;              /* last allocated IOTAG */
259         unsigned long  stats_start;        /* in seconds */
260         struct lpfc_lnk_stat lnk_stat_offsets;
261 };
262
263 #define LPFC_MBOX_TMO           30      /* Sec tmo for outstanding mbox
264                                            command */
265 #define LPFC_MBOX_TMO_FLASH_CMD 300     /* Sec tmo for outstanding FLASH write
266                                          * or erase cmds. This is especially
267                                          * long because of the potential of
268                                          * multiple flash erases that can be
269                                          * spawned.
270                                          */