- patches.fixes/patch-2.6.11-rc1: 2.6.11-rc1.
[linux-flexiantxendom0-3.2.10.git] / drivers / infiniband / hw / mthca / mthca_dev.h
1 /*
2  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and/or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  *
32  * $Id: mthca_dev.h 1349 2004-12-16 21:09:43Z roland $
33  */
34
35 #ifndef MTHCA_DEV_H
36 #define MTHCA_DEV_H
37
38 #include <linux/spinlock.h>
39 #include <linux/kernel.h>
40 #include <linux/pci.h>
41 #include <linux/dma-mapping.h>
42 #include <asm/semaphore.h>
43
44 #include "mthca_provider.h"
45 #include "mthca_doorbell.h"
46
47 #define DRV_NAME        "ib_mthca"
48 #define PFX             DRV_NAME ": "
49 #define DRV_VERSION     "0.06-pre"
50 #define DRV_RELDATE     "November 8, 2004"
51
52 /* Types of supported HCA */
53 enum {
54         TAVOR,                  /* MT23108                        */
55         ARBEL_COMPAT,           /* MT25208 in Tavor compat mode   */
56         ARBEL_NATIVE            /* MT25208 with extended features */
57 };
58
59 enum {
60         MTHCA_FLAG_DDR_HIDDEN = 1 << 1,
61         MTHCA_FLAG_SRQ        = 1 << 2,
62         MTHCA_FLAG_MSI        = 1 << 3,
63         MTHCA_FLAG_MSI_X      = 1 << 4,
64         MTHCA_FLAG_NO_LAM     = 1 << 5
65 };
66
67 enum {
68         MTHCA_KAR_PAGE  = 1,
69         MTHCA_MAX_PORTS = 2
70 };
71
72 enum {
73         MTHCA_EQ_CONTEXT_SIZE =  0x40,
74         MTHCA_CQ_CONTEXT_SIZE =  0x40,
75         MTHCA_QP_CONTEXT_SIZE = 0x200,
76         MTHCA_RDB_ENTRY_SIZE  =  0x20,
77         MTHCA_AV_SIZE         =  0x20,
78         MTHCA_MGM_ENTRY_SIZE  =  0x40,
79
80         /* Arbel FW gives us these, but we need them for Tavor */
81         MTHCA_MPT_ENTRY_SIZE  =  0x40,
82         MTHCA_MTT_SEG_SIZE    =  0x40,
83 };
84
85 enum {
86         MTHCA_EQ_CMD,
87         MTHCA_EQ_ASYNC,
88         MTHCA_EQ_COMP,
89         MTHCA_NUM_EQ
90 };
91
92 struct mthca_cmd {
93         int                       use_events;
94         struct semaphore          hcr_sem;
95         struct semaphore          poll_sem;
96         struct semaphore          event_sem;
97         int                       max_cmds;
98         spinlock_t                context_lock;
99         int                       free_head;
100         struct mthca_cmd_context *context;
101         u16                       token_mask;
102 };
103
104 struct mthca_limits {
105         int      num_ports;
106         int      vl_cap;
107         int      mtu_cap;
108         int      gid_table_len;
109         int      pkey_table_len;
110         int      local_ca_ack_delay;
111         int      max_sg;
112         int      num_qps;
113         int      reserved_qps;
114         int      num_srqs;
115         int      reserved_srqs;
116         int      num_eecs;
117         int      reserved_eecs;
118         int      num_cqs;
119         int      reserved_cqs;
120         int      num_eqs;
121         int      reserved_eqs;
122         int      num_mpts;
123         int      num_mtt_segs;
124         int      mtt_seg_size;
125         int      reserved_mtts;
126         int      reserved_mrws;
127         int      reserved_uars;
128         int      num_mgms;
129         int      num_amgms;
130         int      reserved_mcgs;
131         int      num_pds;
132         int      reserved_pds;
133 };
134
135 struct mthca_alloc {
136         u32            last;
137         u32            top;
138         u32            max;
139         u32            mask;
140         spinlock_t     lock;
141         unsigned long *table;
142 };
143
144 struct mthca_array {
145         struct {
146                 void    **page;
147                 int       used;
148         } *page_list;
149 };
150
151 struct mthca_pd_table {
152         struct mthca_alloc alloc;
153 };
154
155 struct mthca_mr_table {
156         struct mthca_alloc mpt_alloc;
157         int                max_mtt_order;
158         unsigned long    **mtt_buddy;
159         u64                mtt_base;
160 };
161
162 struct mthca_eq_table {
163         struct mthca_alloc alloc;
164         void __iomem      *clr_int;
165         u32                clr_mask;
166         struct mthca_eq    eq[MTHCA_NUM_EQ];
167         int                have_irq;
168         u8                 inta_pin;
169 };
170
171 struct mthca_cq_table {
172         struct mthca_alloc alloc;
173         spinlock_t         lock;
174         struct mthca_array cq;
175 };
176
177 struct mthca_qp_table {
178         struct mthca_alloc alloc;
179         u32                rdb_base;
180         int                rdb_shift;
181         int                sqp_start;
182         spinlock_t         lock;
183         struct mthca_array qp;
184 };
185
186 struct mthca_av_table {
187         struct pci_pool   *pool;
188         int                num_ddr_avs;
189         u64                ddr_av_base;
190         void __iomem      *av_map;
191         struct mthca_alloc alloc;
192 };
193
194 struct mthca_mcg_table {
195         struct semaphore   sem;
196         struct mthca_alloc alloc;
197 };
198
199 struct mthca_dev {
200         struct ib_device  ib_dev;
201         struct pci_dev   *pdev;
202
203         int              hca_type;
204         unsigned long    mthca_flags;
205
206         u32              rev_id;
207
208         /* firmware info */
209         u64              fw_ver;
210         union {
211                 struct {
212                         u64 fw_start;
213                         u64 fw_end;
214                 }        tavor;
215                 struct {
216                         u64 clr_int_base;
217                         u64 eq_arm_base;
218                         u64 eq_set_ci_base;
219                         struct mthca_icm *icm;
220                         u16 fw_pages;
221                 }        arbel;
222         }                fw;
223
224         u64              ddr_start;
225         u64              ddr_end;
226
227         MTHCA_DECLARE_DOORBELL_LOCK(doorbell_lock)
228
229         void __iomem    *hcr;
230         void __iomem    *clr_base;
231         void __iomem    *kar;
232
233         struct mthca_cmd    cmd;
234         struct mthca_limits limits;
235
236         struct mthca_pd_table  pd_table;
237         struct mthca_mr_table  mr_table;
238         struct mthca_eq_table  eq_table;
239         struct mthca_cq_table  cq_table;
240         struct mthca_qp_table  qp_table;
241         struct mthca_av_table  av_table;
242         struct mthca_mcg_table mcg_table;
243
244         struct mthca_pd       driver_pd;
245         struct mthca_mr       driver_mr;
246
247         struct ib_mad_agent  *send_agent[MTHCA_MAX_PORTS][2];
248         struct ib_ah         *sm_ah[MTHCA_MAX_PORTS];
249         spinlock_t            sm_lock;
250 };
251
252 #define mthca_dbg(mdev, format, arg...) \
253         dev_dbg(&mdev->pdev->dev, format, ## arg)
254 #define mthca_err(mdev, format, arg...) \
255         dev_err(&mdev->pdev->dev, format, ## arg)
256 #define mthca_info(mdev, format, arg...) \
257         dev_info(&mdev->pdev->dev, format, ## arg)
258 #define mthca_warn(mdev, format, arg...) \
259         dev_warn(&mdev->pdev->dev, format, ## arg)
260
261 extern void __buggy_use_of_MTHCA_GET(void);
262 extern void __buggy_use_of_MTHCA_PUT(void);
263
264 #define MTHCA_GET(dest, source, offset)                               \
265         do {                                                          \
266                 void *__p = (char *) (source) + (offset);             \
267                 switch (sizeof (dest)) {                              \
268                         case 1: (dest) = *(u8 *) __p;       break;    \
269                         case 2: (dest) = be16_to_cpup(__p); break;    \
270                         case 4: (dest) = be32_to_cpup(__p); break;    \
271                         case 8: (dest) = be64_to_cpup(__p); break;    \
272                         default: __buggy_use_of_MTHCA_GET();          \
273                 }                                                     \
274         } while (0)
275
276 #define MTHCA_PUT(dest, source, offset)                               \
277         do {                                                          \
278                 __typeof__(source) *__p =                             \
279                         (__typeof__(source) *) ((char *) (dest) + (offset)); \
280                 switch (sizeof(source)) {                             \
281                         case 1: *__p = (source);            break;    \
282                         case 2: *__p = cpu_to_be16(source); break;    \
283                         case 4: *__p = cpu_to_be32(source); break;    \
284                         case 8: *__p = cpu_to_be64(source); break;    \
285                         default: __buggy_use_of_MTHCA_PUT();          \
286                 }                                                     \
287         } while (0)
288
289 int mthca_reset(struct mthca_dev *mdev);
290
291 u32 mthca_alloc(struct mthca_alloc *alloc);
292 void mthca_free(struct mthca_alloc *alloc, u32 obj);
293 int mthca_alloc_init(struct mthca_alloc *alloc, u32 num, u32 mask,
294                      u32 reserved);
295 void mthca_alloc_cleanup(struct mthca_alloc *alloc);
296 void *mthca_array_get(struct mthca_array *array, int index);
297 int mthca_array_set(struct mthca_array *array, int index, void *value);
298 void mthca_array_clear(struct mthca_array *array, int index);
299 int mthca_array_init(struct mthca_array *array, int nent);
300 void mthca_array_cleanup(struct mthca_array *array, int nent);
301
302 int mthca_init_pd_table(struct mthca_dev *dev);
303 int mthca_init_mr_table(struct mthca_dev *dev);
304 int mthca_init_eq_table(struct mthca_dev *dev);
305 int mthca_init_cq_table(struct mthca_dev *dev);
306 int mthca_init_qp_table(struct mthca_dev *dev);
307 int mthca_init_av_table(struct mthca_dev *dev);
308 int mthca_init_mcg_table(struct mthca_dev *dev);
309
310 void mthca_cleanup_pd_table(struct mthca_dev *dev);
311 void mthca_cleanup_mr_table(struct mthca_dev *dev);
312 void mthca_cleanup_eq_table(struct mthca_dev *dev);
313 void mthca_cleanup_cq_table(struct mthca_dev *dev);
314 void mthca_cleanup_qp_table(struct mthca_dev *dev);
315 void mthca_cleanup_av_table(struct mthca_dev *dev);
316 void mthca_cleanup_mcg_table(struct mthca_dev *dev);
317
318 int mthca_register_device(struct mthca_dev *dev);
319 void mthca_unregister_device(struct mthca_dev *dev);
320
321 int mthca_pd_alloc(struct mthca_dev *dev, struct mthca_pd *pd);
322 void mthca_pd_free(struct mthca_dev *dev, struct mthca_pd *pd);
323
324 int mthca_mr_alloc_notrans(struct mthca_dev *dev, u32 pd,
325                            u32 access, struct mthca_mr *mr);
326 int mthca_mr_alloc_phys(struct mthca_dev *dev, u32 pd,
327                         u64 *buffer_list, int buffer_size_shift,
328                         int list_len, u64 iova, u64 total_size,
329                         u32 access, struct mthca_mr *mr);
330 void mthca_free_mr(struct mthca_dev *dev, struct mthca_mr *mr);
331
332 int mthca_poll_cq(struct ib_cq *ibcq, int num_entries,
333                   struct ib_wc *entry);
334 void mthca_arm_cq(struct mthca_dev *dev, struct mthca_cq *cq,
335                   int solicited);
336 int mthca_init_cq(struct mthca_dev *dev, int nent,
337                   struct mthca_cq *cq);
338 void mthca_free_cq(struct mthca_dev *dev,
339                    struct mthca_cq *cq);
340 void mthca_cq_event(struct mthca_dev *dev, u32 cqn);
341 void mthca_cq_clean(struct mthca_dev *dev, u32 cqn, u32 qpn);
342
343 void mthca_qp_event(struct mthca_dev *dev, u32 qpn,
344                     enum ib_event_type event_type);
345 int mthca_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr, int attr_mask);
346 int mthca_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
347                     struct ib_send_wr **bad_wr);
348 int mthca_post_receive(struct ib_qp *ibqp, struct ib_recv_wr *wr,
349                        struct ib_recv_wr **bad_wr);
350 int mthca_free_err_wqe(struct mthca_qp *qp, int is_send,
351                        int index, int *dbd, u32 *new_wqe);
352 int mthca_alloc_qp(struct mthca_dev *dev,
353                    struct mthca_pd *pd,
354                    struct mthca_cq *send_cq,
355                    struct mthca_cq *recv_cq,
356                    enum ib_qp_type type,
357                    enum ib_sig_type send_policy,
358                    enum ib_sig_type recv_policy,
359                    struct mthca_qp *qp);
360 int mthca_alloc_sqp(struct mthca_dev *dev,
361                     struct mthca_pd *pd,
362                     struct mthca_cq *send_cq,
363                     struct mthca_cq *recv_cq,
364                     enum ib_sig_type send_policy,
365                     enum ib_sig_type recv_policy,
366                     int qpn,
367                     int port,
368                     struct mthca_sqp *sqp);
369 void mthca_free_qp(struct mthca_dev *dev, struct mthca_qp *qp);
370 int mthca_create_ah(struct mthca_dev *dev,
371                     struct mthca_pd *pd,
372                     struct ib_ah_attr *ah_attr,
373                     struct mthca_ah *ah);
374 int mthca_destroy_ah(struct mthca_dev *dev, struct mthca_ah *ah);
375 int mthca_read_ah(struct mthca_dev *dev, struct mthca_ah *ah,
376                   struct ib_ud_header *header);
377
378 int mthca_multicast_attach(struct ib_qp *ibqp, union ib_gid *gid, u16 lid);
379 int mthca_multicast_detach(struct ib_qp *ibqp, union ib_gid *gid, u16 lid);
380
381 int mthca_process_mad(struct ib_device *ibdev,
382                       int mad_flags,
383                       u8 port_num,
384                       struct ib_wc *in_wc,
385                       struct ib_grh *in_grh,
386                       struct ib_mad *in_mad,
387                       struct ib_mad *out_mad);
388 int mthca_create_agents(struct mthca_dev *dev);
389 void mthca_free_agents(struct mthca_dev *dev);
390
391 static inline struct mthca_dev *to_mdev(struct ib_device *ibdev)
392 {
393         return container_of(ibdev, struct mthca_dev, ib_dev);
394 }
395
396 #endif /* MTHCA_DEV_H */