]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/scsi/lpfc/lpfc_sli.h
/home/lenb/src/to-linus branch 'acpi-2.6.12'
[linux-2.6-omap-h63xx.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-2005 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
24 /* Define the context types that SLI handles for abort and sums. */
25 typedef enum _lpfc_ctx_cmd {
26         LPFC_CTX_LUN,
27         LPFC_CTX_TGT,
28         LPFC_CTX_CTX,
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         IOCB_t iocb;            /* IOCB cmd */
37         uint8_t retry;          /* retry counter for IOCB cmd - if needed */
38         uint8_t iocb_flag;
39 #define LPFC_IO_POLL    1       /* Polling mode iocb */
40 #define LPFC_IO_LIBDFC  2       /* libdfc iocb */
41 #define LPFC_IO_WAIT    4
42 #define LPFC_IO_HIPRI   8       /* High Priority Queue signal flag */
43
44         uint8_t abort_count;
45         uint8_t rsvd2;
46         uint32_t drvrTimeout;   /* driver timeout in seconds */
47         void *context1;         /* caller context information */
48         void *context2;         /* caller context information */
49         void *context3;         /* caller context information */
50         union {
51                 wait_queue_head_t *hipri_wait_queue; /* High Priority Queue wait
52                                                         queue */
53                 struct lpfc_iocbq  *rsp_iocb;
54                 struct lpfcMboxq   *mbox;
55         } context_un;
56
57         void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
58                            struct lpfc_iocbq *);
59
60 };
61
62 #define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
63 #define SLI_IOCB_HIGH_PRIORITY 2        /* High priority command */
64
65 #define IOCB_SUCCESS        0
66 #define IOCB_BUSY           1
67 #define IOCB_ERROR          2
68 #define IOCB_TIMEDOUT       3
69
70 typedef struct lpfcMboxq {
71         /* MBOXQs are used in single linked lists */
72         struct list_head list;  /* ptr to next mailbox command */
73         MAILBOX_t mb;           /* Mailbox cmd */
74         void *context1;         /* caller context information */
75         void *context2;         /* caller context information */
76
77         void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
78
79 } LPFC_MBOXQ_t;
80
81 #define MBX_POLL        1       /* poll mailbox till command done, then
82                                    return */
83 #define MBX_NOWAIT      2       /* issue command then return immediately */
84 #define MBX_STOP_IOCB   4       /* Stop iocb processing till mbox cmds
85                                    complete */
86
87 #define LPFC_MAX_RING_MASK  4   /* max num of rctl/type masks allowed per
88                                    ring */
89 #define LPFC_MAX_RING       4   /* max num of SLI rings used by driver */
90
91 struct lpfc_sli_ring;
92
93 struct lpfc_sli_ring_mask {
94         uint8_t profile;        /* profile associated with ring */
95         uint8_t rctl;   /* rctl / type pair configured for ring */
96         uint8_t type;   /* rctl / type pair configured for ring */
97         uint8_t rsvd;
98         /* rcv'd unsol event */
99         void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
100                                          struct lpfc_sli_ring *,
101                                          struct lpfc_iocbq *);
102 };
103
104
105 /* Structure used to hold SLI statistical counters and info */
106 struct lpfc_sli_ring_stat {
107         uint64_t iocb_event;     /* IOCB event counters */
108         uint64_t iocb_cmd;       /* IOCB cmd issued */
109         uint64_t iocb_rsp;       /* IOCB rsp received */
110         uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
111         uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
112         uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
113         uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
114 };
115
116 /* Structure used to hold SLI ring information */
117 struct lpfc_sli_ring {
118         uint16_t flag;          /* ring flags */
119 #define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
120 #define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
121 #define LPFC_STOP_IOCB_MBX       0x010  /* Stop processing IOCB cmds mbox */
122 #define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
123 #define LPFC_STOP_IOCB_MASK      0x030  /* Stop processing IOCB cmds mask */
124         uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
125
126         uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
127         uint32_t next_cmdidx;    /* next_cmd index */
128         uint8_t rsvd;
129         uint8_t ringno;         /* ring number */
130         uint8_t rspidx;         /* current index in response ring */
131         uint8_t cmdidx;         /* current index in command ring */
132         uint16_t numCiocb;      /* number of command iocb's per ring */
133         uint16_t numRiocb;      /* number of rsp iocb's per ring */
134
135         uint32_t fast_iotag;    /* max fastlookup based iotag           */
136         uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
137         uint32_t iotag_max;     /* max iotag value to use               */
138         struct lpfc_iocbq ** fast_lookup; /* array of IOCB ptrs indexed by
139                                            iotag */
140         struct list_head txq;
141         uint16_t txq_cnt;       /* current length of queue */
142         uint16_t txq_max;       /* max length */
143         struct list_head txcmplq;
144         uint16_t txcmplq_cnt;   /* current length of queue */
145         uint16_t txcmplq_max;   /* max length */
146         uint32_t *cmdringaddr;  /* virtual address for cmd rings */
147         uint32_t *rspringaddr;  /* virtual address for rsp rings */
148         uint32_t missbufcnt;    /* keep track of buffers to post */
149         struct list_head postbufq;
150         uint16_t postbufq_cnt;  /* current length of queue */
151         uint16_t postbufq_max;  /* max length */
152         struct list_head iocb_continueq;
153         uint16_t iocb_continueq_cnt;    /* current length of queue */
154         uint16_t iocb_continueq_max;    /* max length */
155
156         struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
157         uint32_t num_mask;      /* number of mask entries in prt array */
158
159         struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
160
161         /* cmd ring available */
162         void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
163                                         struct lpfc_sli_ring *);
164 };
165
166 /* Structure used to hold SLI statistical counters and info */
167 struct lpfc_sli_stat {
168         uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
169         uint64_t mbox_cmd;       /* Mailbox commands issued */
170         uint64_t sli_intr;       /* Count of Host Attention interrupts */
171         uint32_t err_attn_event; /* Error Attn event counters */
172         uint32_t link_event;     /* Link event counters */
173         uint32_t mbox_event;     /* Mailbox event counters */
174         uint32_t mbox_busy;      /* Mailbox cmd busy */
175 };
176
177 /* Structure used to hold SLI information */
178 struct lpfc_sli {
179         uint32_t num_rings;
180         uint32_t sli_flag;
181
182         /* Additional sli_flags */
183 #define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
184 #define LPFC_SLI2_ACTIVE          0x200 /* SLI2 overlay in firmware is active */
185 #define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
186
187         struct lpfc_sli_ring ring[LPFC_MAX_RING];
188         int fcp_ring;           /* ring used for FCP initiator commands */
189         int next_ring;
190
191         int ip_ring;            /* ring used for IP network drv cmds */
192
193         struct lpfc_sli_stat slistat;   /* SLI statistical info */
194         struct list_head mboxq;
195         uint16_t mboxq_cnt;     /* current length of queue */
196         uint16_t mboxq_max;     /* max length */
197         LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
198
199         struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
200                                            cmd */
201
202         uint32_t *MBhostaddr;   /* virtual address for mbox cmds */
203 };
204
205 /* Given a pointer to the start of the ring, and the slot number of
206  * the desired iocb entry, calc a pointer to that entry.
207  * (assume iocb entry size is 32 bytes, or 8 words)
208  */
209 #define IOCB_ENTRY(ring,slot) ((IOCB_t *)(((char *)(ring)) + ((slot) * 32)))
210
211 #define LPFC_MBOX_TMO           30      /* Sec tmo for outstanding mbox
212                                            command */