42b33b6399a86112789a677438989a35d175ae26
[mirror/winof/.git] / hw / mthca / user / mlnx_uvp.h
1 /*
2  * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
3  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  *
33  * $Id$
34  */
35
36 #ifndef MTHCA_H
37 #define MTHCA_H
38
39 #include <cl_spinlock.h>
40 #include <mlnx_uvp_verbs.h>
41 #include <arch.h>
42 #include "mlnx_uvp_debug.h"
43
44 #define PFX             "mthca: "
45
46 enum mthca_hca_type {
47         MTHCA_TAVOR,
48         MTHCA_ARBEL,
49         MTHCA_LIVEFISH
50 };
51
52 enum {
53         MTHCA_CQ_ENTRY_SIZE = 0x20,
54         MTHCA_BYTES_PER_ATOMIC_COMPL = 0x8
55 };
56
57 enum {
58         MTHCA_QP_TABLE_BITS = 8,
59         MTHCA_QP_TABLE_SIZE = 1 << MTHCA_QP_TABLE_BITS,
60         MTHCA_QP_TABLE_MASK = MTHCA_QP_TABLE_SIZE - 1
61 };
62
63 enum {
64         MTHCA_DB_REC_PAGE_SIZE = 4096,
65         MTHCA_DB_REC_PER_PAGE  = MTHCA_DB_REC_PAGE_SIZE / 8
66 };
67
68 enum mthca_db_type {
69         MTHCA_DB_TYPE_INVALID   = 0x0,
70         MTHCA_DB_TYPE_CQ_SET_CI = 0x1,
71         MTHCA_DB_TYPE_CQ_ARM    = 0x2,
72         MTHCA_DB_TYPE_SQ        = 0x3,
73         MTHCA_DB_TYPE_RQ        = 0x4,
74         MTHCA_DB_TYPE_SRQ       = 0x5,
75         MTHCA_DB_TYPE_GROUP_SEP = 0x7
76 };
77
78 enum mthca_wr_opcode {
79         MTHCA_OPCODE_NOP            = 0x00,
80         MTHCA_OPCODE_RDMA_WRITE     = 0x08,
81         MTHCA_OPCODE_RDMA_WRITE_IMM = 0x09,
82         MTHCA_OPCODE_SEND           = 0x0a,
83         MTHCA_OPCODE_SEND_IMM       = 0x0b,
84         MTHCA_OPCODE_RDMA_READ      = 0x10,
85         MTHCA_OPCODE_ATOMIC_CS      = 0x11,
86         MTHCA_OPCODE_ATOMIC_FA      = 0x12,
87         MTHCA_OPCODE_BIND_MW        = 0x18,
88         MTHCA_OPCODE_INVALID        = 0xff
89 };
90
91 struct mthca_ah_page;
92
93 struct mthca_db_table;
94
95 struct mthca_context {
96         struct ibv_context     ibv_ctx;
97         void                  *uar;
98         cl_spinlock_t     uar_lock;
99         struct mthca_db_table *db_tab;
100         struct ibv_pd         *pd;
101         struct {
102                 struct mthca_qp **table;
103                 int               refcnt;
104         }                      qp_table[MTHCA_QP_TABLE_SIZE];
105         HANDLE        qp_table_mutex;
106         int                    num_qps;
107         int                    qp_table_shift;
108         int                    qp_table_mask;
109         enum mthca_hca_type hca_type;
110 };
111
112 struct mthca_pd {
113         struct ibv_pd         ibv_pd;
114         struct mthca_ah_page *ah_list;
115         HANDLE       ah_mutex;
116         uint32_t              pdn;
117 };
118
119 struct mthca_cq {
120         struct ibv_cq      ibv_cq;
121         void              *buf;
122         cl_spinlock_t lock;
123         struct ibv_mr     mr;
124         uint32_t           cqn;
125         uint32_t           cons_index;
126
127         /* Next fields are mem-free only */
128         int                set_ci_db_index;
129         uint32_t          *set_ci_db;
130         int                arm_db_index;
131         uint32_t          *arm_db;
132         int                u_arm_db_index;
133         uint32_t          *p_u_arm_sn;
134 };
135
136 struct mthca_srq {
137         struct ibv_srq     ibv_srq;
138         void              *buf;
139         void              *last;
140         cl_spinlock_t lock;
141         struct ibv_mr     mr;
142         uint64_t          *wrid;
143         uint32_t           srqn;
144         int                max;
145         int                max_gs;
146         int                wqe_shift;
147         int                first_free;
148         int                last_free;
149         int                buf_size;
150
151         /* Next fields are mem-free only */
152         int                db_index;
153         uint32_t          *db;
154         uint16_t           counter;
155 };
156
157 struct mthca_wq {
158         cl_spinlock_t lock;
159         int                max;
160         unsigned           next_ind;
161         unsigned           last_comp;
162         unsigned           head;
163         unsigned           tail;
164         void              *last;
165         int                max_gs;
166         int                wqe_shift;
167
168         /* Next fields are mem-free only */
169         int                db_index;
170         uint32_t          *db;
171 };
172
173 struct mthca_qp {
174         struct ibv_qp    ibv_qp;
175         uint8_t            *buf;
176         uint64_t        *wrid;
177         int              send_wqe_offset;
178         int              max_inline_data;
179         int              buf_size;
180         struct mthca_wq  sq;
181         struct mthca_wq  rq;
182         struct ibv_mr   mr;
183         int              sq_sig_all;
184 };
185
186 struct mthca_av {
187         uint32_t port_pd;
188         uint8_t  reserved1;
189         uint8_t  g_slid;
190         uint16_t dlid;
191         uint8_t  reserved2;
192         uint8_t  gid_index;
193         uint8_t  msg_sr;
194         uint8_t  hop_limit;
195         uint32_t sl_tclass_flowlabel;
196         uint32_t dgid[4];
197 };
198
199 struct mthca_ah {
200         struct mthca_av      *av;
201         ib_av_attr_t            av_attr;
202 TO_LONG_PTR(    ib_pd_handle_t ,        h_uvp_pd) ; 
203         struct mthca_ah_page *page;
204         uint32_t              key;
205         int     in_kernel;
206 };
207
208 #pragma warning( disable : 4200)
209 struct mthca_ah_page {
210         struct mthca_ah_page *prev, *next;
211         void                 *buf;
212         struct ibv_mr        mr;
213         int                   use_cnt;
214         unsigned              free[0];
215 };
216 #pragma warning( default  : 4200)
217
218
219 static inline uintptr_t db_align(uint32_t *db)
220 {
221         return (uintptr_t) db & ~((uintptr_t) MTHCA_DB_REC_PAGE_SIZE - 1);
222 }
223
224 #define to_mxxx(xxx, type)                                              \
225         ((struct mthca_##type *)                                        \
226          ((uint8_t *) ib##xxx - offsetof(struct mthca_##type, ibv_##xxx)))
227
228 static inline struct mthca_context *to_mctx(struct ibv_context *ibctx)
229 {
230         return to_mxxx(ctx, context);
231 }
232
233 static inline struct mthca_pd *to_mpd(struct ibv_pd *ibpd)
234 {
235         return to_mxxx(pd, pd);
236 }
237
238 static inline struct mthca_cq *to_mcq(struct ibv_cq *ibcq)
239 {
240         return to_mxxx(cq, cq);
241 }
242
243 static inline struct mthca_srq *to_msrq(struct ibv_srq *ibsrq)
244 {
245         return to_mxxx(srq, srq);
246 }
247
248 static inline struct mthca_qp *to_mqp(struct ibv_qp *ibqp)
249 {
250         return to_mxxx(qp, qp);
251 }
252
253 static inline int mthca_is_memfree(struct ibv_context *ibctx)
254 {
255         return to_mctx(ibctx)->hca_type == MTHCA_ARBEL;
256 }
257
258 int mthca_alloc_db(struct mthca_db_table *db_tab, enum mthca_db_type type,
259                           uint32_t **db);
260 void mthca_set_db_qn(uint32_t *db, enum mthca_db_type type, uint32_t qn);
261 void mthca_free_db(struct mthca_db_table *db_tab, enum mthca_db_type type, int db_index);
262 struct mthca_db_table *mthca_alloc_db_tab(int uarc_size);
263 void mthca_free_db_tab(struct mthca_db_table *db_tab);
264
265 int mthca_query_device(struct ibv_context *context,
266                               struct ibv_device_attr *attr);
267 int mthca_query_port(struct ibv_context *context, uint8_t port,
268                             struct ibv_port_attr *attr);
269
270         struct ibv_pd *mthca_alloc_pd(struct ibv_context *context, 
271         struct ibv_alloc_pd_resp *resp_p);
272
273 int mthca_free_pd(struct ibv_pd *pd);
274
275 struct ibv_cq *mthca_create_cq_pre(struct ibv_context *context, int *cqe,
276                                  struct ibv_create_cq *req);
277 struct ibv_cq *mthca_create_cq_post(struct ibv_context *context, 
278                                  struct ibv_create_cq_resp *resp);
279 int mthca_destroy_cq(struct ibv_cq *cq);
280 int mthca_poll_cq(struct ibv_cq *cq, int ne, struct _ib_wc *wc);
281 int mthca_poll_cq_list(struct ibv_cq *ibcq, 
282         struct _ib_wc** const pp_free_wclist,
283         struct _ib_wc** const pp_done_wclist );
284 int mthca_tavor_arm_cq(struct ibv_cq *cq, int solicited);
285 int mthca_arbel_arm_cq(struct ibv_cq *cq, int solicited);
286 void mthca_cq_clean(struct mthca_cq *cq, uint32_t qpn,
287                            struct mthca_srq *srq);
288 void mthca_init_cq_buf(struct mthca_cq *cq, int nent);
289
290 struct ibv_srq *mthca_create_srq(struct ibv_pd *pd,
291                                         struct ibv_srq_init_attr *attr);
292 int mthca_modify_srq(struct ibv_srq *srq,
293                             struct ibv_srq_attr *attr,
294                             enum ibv_srq_attr_mask mask);
295 int mthca_destroy_srq(struct ibv_srq *srq);
296 int mthca_alloc_srq_buf(struct ibv_pd *pd, struct ibv_srq_attr *attr,
297                                struct mthca_srq *srq);
298 void mthca_free_srq_wqe(struct mthca_srq *srq, int ind);
299 int mthca_tavor_post_srq_recv(struct ibv_srq *ibsrq,
300                                      struct _ib_recv_wr *wr,
301                                      struct _ib_recv_wr **bad_wr);
302 int mthca_arbel_post_srq_recv(struct ibv_srq *ibsrq,
303                                      struct _ib_recv_wr *wr,
304                                      struct _ib_recv_wr **bad_wr);
305 struct ibv_qp *mthca_create_qp_pre(struct ibv_pd *pd, 
306         struct ibv_qp_init_attr *attr, struct ibv_create_qp *req);
307 struct ibv_qp *mthca_create_qp_post(struct ibv_pd *pd, 
308         struct ibv_create_qp_resp *resp);
309 int mthca_modify_qp(struct ibv_qp *qp, struct ibv_qp_attr *attr,
310                            enum ibv_qp_attr_mask attr_mask);
311 void mthca_destroy_qp_pre(struct ibv_qp *qp);
312 void mthca_destroy_qp_post(struct ibv_qp *qp, int ret);
313 void mthca_init_qp_indices(struct mthca_qp *qp);
314 int mthca_tavor_post_send(struct ibv_qp *ibqp, struct _ib_send_wr *wr,
315                                  struct _ib_send_wr **bad_wr);
316 int mthca_tavor_post_recv(struct ibv_qp *ibqp, struct _ib_recv_wr *wr,
317                                  struct _ib_recv_wr **bad_wr);
318 int mthca_arbel_post_send(struct ibv_qp *ibqp, struct _ib_send_wr *wr,
319                                  struct _ib_send_wr **bad_wr);
320 int mthca_arbel_post_recv(struct ibv_qp *ibqp, struct _ib_recv_wr *wr,
321                                  struct _ib_recv_wr **bad_wr);
322 int mthca_alloc_qp_buf(struct ibv_pd *pd, struct ibv_qp_cap *cap,
323                               ib_qp_type_t type, struct mthca_qp *qp);
324 struct mthca_qp *mthca_find_qp(struct mthca_context *ctx, uint32_t qpn);
325 int mthca_store_qp(struct mthca_context *ctx, uint32_t qpn, struct mthca_qp *qp);
326 void mthca_clear_qp(struct mthca_context *ctx, uint32_t qpn);
327 int mthca_free_err_wqe(struct mthca_qp *qp, int is_send,
328                               int index, int *dbd, uint32_t *new_wqe);
329 int mthca_alloc_av(struct mthca_pd *pd, struct ibv_ah_attr *attr,
330                           struct mthca_ah *ah, struct ibv_create_ah_resp *resp);
331 void mthca_free_av(struct mthca_ah *ah);
332 int mthca_attach_mcast(struct ibv_qp *qp, union ibv_gid *gid, uint16_t lid);
333 int mthca_detach_mcast(struct ibv_qp *qp, union ibv_gid *gid, uint16_t lid);
334 struct ibv_context *mthca_alloc_context(struct ibv_get_context_resp *resp_p);
335 void mthca_free_context(struct ibv_context *ibctx);
336
337 #endif /* MTHCA_H */