IB/mlx5: Enhance UMR support to allow partial page table update
[linux-2.6-block.git] / drivers / infiniband / hw / mlx5 / mlx5_ib.h
1 /*
2  * Copyright (c) 2013, Mellanox Technologies inc.  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
33 #ifndef MLX5_IB_H
34 #define MLX5_IB_H
35
36 #include <linux/kernel.h>
37 #include <linux/sched.h>
38 #include <rdma/ib_verbs.h>
39 #include <rdma/ib_smi.h>
40 #include <linux/mlx5/driver.h>
41 #include <linux/mlx5/cq.h>
42 #include <linux/mlx5/qp.h>
43 #include <linux/mlx5/srq.h>
44 #include <linux/types.h>
45
46 #define mlx5_ib_dbg(dev, format, arg...)                                \
47 pr_debug("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,    \
48          __LINE__, current->pid, ##arg)
49
50 #define mlx5_ib_err(dev, format, arg...)                                \
51 pr_err("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,      \
52         __LINE__, current->pid, ##arg)
53
54 #define mlx5_ib_warn(dev, format, arg...)                               \
55 pr_warn("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,     \
56         __LINE__, current->pid, ##arg)
57
58 enum {
59         MLX5_IB_MMAP_CMD_SHIFT  = 8,
60         MLX5_IB_MMAP_CMD_MASK   = 0xff,
61 };
62
63 enum mlx5_ib_mmap_cmd {
64         MLX5_IB_MMAP_REGULAR_PAGE               = 0,
65         MLX5_IB_MMAP_GET_CONTIGUOUS_PAGES       = 1, /* always last */
66 };
67
68 enum {
69         MLX5_RES_SCAT_DATA32_CQE        = 0x1,
70         MLX5_RES_SCAT_DATA64_CQE        = 0x2,
71         MLX5_REQ_SCAT_DATA32_CQE        = 0x11,
72         MLX5_REQ_SCAT_DATA64_CQE        = 0x22,
73 };
74
75 enum mlx5_ib_latency_class {
76         MLX5_IB_LATENCY_CLASS_LOW,
77         MLX5_IB_LATENCY_CLASS_MEDIUM,
78         MLX5_IB_LATENCY_CLASS_HIGH,
79         MLX5_IB_LATENCY_CLASS_FAST_PATH
80 };
81
82 enum mlx5_ib_mad_ifc_flags {
83         MLX5_MAD_IFC_IGNORE_MKEY        = 1,
84         MLX5_MAD_IFC_IGNORE_BKEY        = 2,
85         MLX5_MAD_IFC_NET_VIEW           = 4,
86 };
87
88 struct mlx5_ib_ucontext {
89         struct ib_ucontext      ibucontext;
90         struct list_head        db_page_list;
91
92         /* protect doorbell record alloc/free
93          */
94         struct mutex            db_page_mutex;
95         struct mlx5_uuar_info   uuari;
96 };
97
98 static inline struct mlx5_ib_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
99 {
100         return container_of(ibucontext, struct mlx5_ib_ucontext, ibucontext);
101 }
102
103 struct mlx5_ib_pd {
104         struct ib_pd            ibpd;
105         u32                     pdn;
106         u32                     pa_lkey;
107 };
108
109 /* Use macros here so that don't have to duplicate
110  * enum ib_send_flags and enum ib_qp_type for low-level driver
111  */
112
113 #define MLX5_IB_SEND_UMR_UNREG  IB_SEND_RESERVED_START
114 #define MLX5_IB_SEND_UMR_FAIL_IF_FREE (IB_SEND_RESERVED_START << 1)
115 #define MLX5_IB_SEND_UMR_UPDATE_MTT (IB_SEND_RESERVED_START << 2)
116 #define MLX5_IB_QPT_REG_UMR     IB_QPT_RESERVED1
117 #define MLX5_IB_WR_UMR          IB_WR_RESERVED1
118
119 struct wr_list {
120         u16     opcode;
121         u16     next;
122 };
123
124 struct mlx5_ib_wq {
125         u64                    *wrid;
126         u32                    *wr_data;
127         struct wr_list         *w_list;
128         unsigned               *wqe_head;
129         u16                     unsig_count;
130
131         /* serialize post to the work queue
132          */
133         spinlock_t              lock;
134         int                     wqe_cnt;
135         int                     max_post;
136         int                     max_gs;
137         int                     offset;
138         int                     wqe_shift;
139         unsigned                head;
140         unsigned                tail;
141         u16                     cur_post;
142         u16                     last_poll;
143         void                   *qend;
144 };
145
146 enum {
147         MLX5_QP_USER,
148         MLX5_QP_KERNEL,
149         MLX5_QP_EMPTY
150 };
151
152 struct mlx5_ib_qp {
153         struct ib_qp            ibqp;
154         struct mlx5_core_qp     mqp;
155         struct mlx5_buf         buf;
156
157         struct mlx5_db          db;
158         struct mlx5_ib_wq       rq;
159
160         u32                     doorbell_qpn;
161         u8                      sq_signal_bits;
162         u8                      fm_cache;
163         int                     sq_max_wqes_per_wr;
164         int                     sq_spare_wqes;
165         struct mlx5_ib_wq       sq;
166
167         struct ib_umem         *umem;
168         int                     buf_size;
169
170         /* serialize qp state modifications
171          */
172         struct mutex            mutex;
173         u16                     xrcdn;
174         u32                     flags;
175         u8                      port;
176         u8                      alt_port;
177         u8                      atomic_rd_en;
178         u8                      resp_depth;
179         u8                      state;
180         int                     mlx_type;
181         int                     wq_sig;
182         int                     scat_cqe;
183         int                     max_inline_data;
184         struct mlx5_bf         *bf;
185         int                     has_rq;
186
187         /* only for user space QPs. For kernel
188          * we have it from the bf object
189          */
190         int                     uuarn;
191
192         int                     create_type;
193         u32                     pa_lkey;
194
195         /* Store signature errors */
196         bool                    signature_en;
197 };
198
199 struct mlx5_ib_cq_buf {
200         struct mlx5_buf         buf;
201         struct ib_umem          *umem;
202         int                     cqe_size;
203         int                     nent;
204 };
205
206 enum mlx5_ib_qp_flags {
207         MLX5_IB_QP_BLOCK_MULTICAST_LOOPBACK     = 1 << 0,
208         MLX5_IB_QP_SIGNATURE_HANDLING           = 1 << 1,
209 };
210
211 struct mlx5_umr_wr {
212         union {
213                 u64                     virt_addr;
214                 u64                     offset;
215         } target;
216         struct ib_pd                   *pd;
217         unsigned int                    page_shift;
218         unsigned int                    npages;
219         u32                             length;
220         int                             access_flags;
221         u32                             mkey;
222 };
223
224 struct mlx5_shared_mr_info {
225         int mr_id;
226         struct ib_umem          *umem;
227 };
228
229 struct mlx5_ib_cq {
230         struct ib_cq            ibcq;
231         struct mlx5_core_cq     mcq;
232         struct mlx5_ib_cq_buf   buf;
233         struct mlx5_db          db;
234
235         /* serialize access to the CQ
236          */
237         spinlock_t              lock;
238
239         /* protect resize cq
240          */
241         struct mutex            resize_mutex;
242         struct mlx5_ib_cq_buf  *resize_buf;
243         struct ib_umem         *resize_umem;
244         int                     cqe_size;
245 };
246
247 struct mlx5_ib_srq {
248         struct ib_srq           ibsrq;
249         struct mlx5_core_srq    msrq;
250         struct mlx5_buf         buf;
251         struct mlx5_db          db;
252         u64                    *wrid;
253         /* protect SRQ hanlding
254          */
255         spinlock_t              lock;
256         int                     head;
257         int                     tail;
258         u16                     wqe_ctr;
259         struct ib_umem         *umem;
260         /* serialize arming a SRQ
261          */
262         struct mutex            mutex;
263         int                     wq_sig;
264 };
265
266 struct mlx5_ib_xrcd {
267         struct ib_xrcd          ibxrcd;
268         u32                     xrcdn;
269 };
270
271 struct mlx5_ib_mr {
272         struct ib_mr            ibmr;
273         struct mlx5_core_mr     mmr;
274         struct ib_umem         *umem;
275         struct mlx5_shared_mr_info      *smr_info;
276         struct list_head        list;
277         int                     order;
278         int                     umred;
279         int                     npages;
280         struct mlx5_ib_dev     *dev;
281         struct mlx5_create_mkey_mbox_out out;
282         struct mlx5_core_sig_ctx    *sig;
283 };
284
285 struct mlx5_ib_fast_reg_page_list {
286         struct ib_fast_reg_page_list    ibfrpl;
287         __be64                         *mapped_page_list;
288         dma_addr_t                      map;
289 };
290
291 struct mlx5_ib_umr_context {
292         enum ib_wc_status       status;
293         struct completion       done;
294 };
295
296 static inline void mlx5_ib_init_umr_context(struct mlx5_ib_umr_context *context)
297 {
298         context->status = -1;
299         init_completion(&context->done);
300 }
301
302 struct umr_common {
303         struct ib_pd    *pd;
304         struct ib_cq    *cq;
305         struct ib_qp    *qp;
306         struct ib_mr    *mr;
307         /* control access to UMR QP
308          */
309         struct semaphore        sem;
310 };
311
312 enum {
313         MLX5_FMR_INVALID,
314         MLX5_FMR_VALID,
315         MLX5_FMR_BUSY,
316 };
317
318 struct mlx5_ib_fmr {
319         struct ib_fmr                   ibfmr;
320         struct mlx5_core_mr             mr;
321         int                             access_flags;
322         int                             state;
323         /* protect fmr state
324          */
325         spinlock_t                      lock;
326         u64                             wrid;
327         struct ib_send_wr               wr[2];
328         u8                              page_shift;
329         struct ib_fast_reg_page_list    page_list;
330 };
331
332 struct mlx5_cache_ent {
333         struct list_head        head;
334         /* sync access to the cahce entry
335          */
336         spinlock_t              lock;
337
338
339         struct dentry          *dir;
340         char                    name[4];
341         u32                     order;
342         u32                     size;
343         u32                     cur;
344         u32                     miss;
345         u32                     limit;
346
347         struct dentry          *fsize;
348         struct dentry          *fcur;
349         struct dentry          *fmiss;
350         struct dentry          *flimit;
351
352         struct mlx5_ib_dev     *dev;
353         struct work_struct      work;
354         struct delayed_work     dwork;
355         int                     pending;
356 };
357
358 struct mlx5_mr_cache {
359         struct workqueue_struct *wq;
360         struct mlx5_cache_ent   ent[MAX_MR_CACHE_ENTRIES];
361         int                     stopped;
362         struct dentry           *root;
363         unsigned long           last_add;
364 };
365
366 struct mlx5_ib_resources {
367         struct ib_cq    *c0;
368         struct ib_xrcd  *x0;
369         struct ib_xrcd  *x1;
370         struct ib_pd    *p0;
371         struct ib_srq   *s0;
372 };
373
374 struct mlx5_ib_dev {
375         struct ib_device                ib_dev;
376         struct mlx5_core_dev            *mdev;
377         MLX5_DECLARE_DOORBELL_LOCK(uar_lock);
378         struct list_head                eqs_list;
379         int                             num_ports;
380         int                             num_comp_vectors;
381         /* serialize update of capability mask
382          */
383         struct mutex                    cap_mask_mutex;
384         bool                            ib_active;
385         struct umr_common               umrc;
386         /* sync used page count stats
387          */
388         spinlock_t                      mr_lock;
389         struct mlx5_ib_resources        devr;
390         struct mlx5_mr_cache            cache;
391         struct timer_list               delay_timer;
392         int                             fill_delay;
393 };
394
395 static inline struct mlx5_ib_cq *to_mibcq(struct mlx5_core_cq *mcq)
396 {
397         return container_of(mcq, struct mlx5_ib_cq, mcq);
398 }
399
400 static inline struct mlx5_ib_xrcd *to_mxrcd(struct ib_xrcd *ibxrcd)
401 {
402         return container_of(ibxrcd, struct mlx5_ib_xrcd, ibxrcd);
403 }
404
405 static inline struct mlx5_ib_dev *to_mdev(struct ib_device *ibdev)
406 {
407         return container_of(ibdev, struct mlx5_ib_dev, ib_dev);
408 }
409
410 static inline struct mlx5_ib_fmr *to_mfmr(struct ib_fmr *ibfmr)
411 {
412         return container_of(ibfmr, struct mlx5_ib_fmr, ibfmr);
413 }
414
415 static inline struct mlx5_ib_cq *to_mcq(struct ib_cq *ibcq)
416 {
417         return container_of(ibcq, struct mlx5_ib_cq, ibcq);
418 }
419
420 static inline struct mlx5_ib_qp *to_mibqp(struct mlx5_core_qp *mqp)
421 {
422         return container_of(mqp, struct mlx5_ib_qp, mqp);
423 }
424
425 static inline struct mlx5_ib_mr *to_mibmr(struct mlx5_core_mr *mmr)
426 {
427         return container_of(mmr, struct mlx5_ib_mr, mmr);
428 }
429
430 static inline struct mlx5_ib_pd *to_mpd(struct ib_pd *ibpd)
431 {
432         return container_of(ibpd, struct mlx5_ib_pd, ibpd);
433 }
434
435 static inline struct mlx5_ib_srq *to_msrq(struct ib_srq *ibsrq)
436 {
437         return container_of(ibsrq, struct mlx5_ib_srq, ibsrq);
438 }
439
440 static inline struct mlx5_ib_qp *to_mqp(struct ib_qp *ibqp)
441 {
442         return container_of(ibqp, struct mlx5_ib_qp, ibqp);
443 }
444
445 static inline struct mlx5_ib_srq *to_mibsrq(struct mlx5_core_srq *msrq)
446 {
447         return container_of(msrq, struct mlx5_ib_srq, msrq);
448 }
449
450 static inline struct mlx5_ib_mr *to_mmr(struct ib_mr *ibmr)
451 {
452         return container_of(ibmr, struct mlx5_ib_mr, ibmr);
453 }
454
455 static inline struct mlx5_ib_fast_reg_page_list *to_mfrpl(struct ib_fast_reg_page_list *ibfrpl)
456 {
457         return container_of(ibfrpl, struct mlx5_ib_fast_reg_page_list, ibfrpl);
458 }
459
460 struct mlx5_ib_ah {
461         struct ib_ah            ibah;
462         struct mlx5_av          av;
463 };
464
465 static inline struct mlx5_ib_ah *to_mah(struct ib_ah *ibah)
466 {
467         return container_of(ibah, struct mlx5_ib_ah, ibah);
468 }
469
470 int mlx5_ib_db_map_user(struct mlx5_ib_ucontext *context, unsigned long virt,
471                         struct mlx5_db *db);
472 void mlx5_ib_db_unmap_user(struct mlx5_ib_ucontext *context, struct mlx5_db *db);
473 void __mlx5_ib_cq_clean(struct mlx5_ib_cq *cq, u32 qpn, struct mlx5_ib_srq *srq);
474 void mlx5_ib_cq_clean(struct mlx5_ib_cq *cq, u32 qpn, struct mlx5_ib_srq *srq);
475 void mlx5_ib_free_srq_wqe(struct mlx5_ib_srq *srq, int wqe_index);
476 int mlx5_MAD_IFC(struct mlx5_ib_dev *dev, int ignore_mkey, int ignore_bkey,
477                  u8 port, struct ib_wc *in_wc, struct ib_grh *in_grh,
478                  void *in_mad, void *response_mad);
479 struct ib_ah *create_ib_ah(struct ib_ah_attr *ah_attr,
480                            struct mlx5_ib_ah *ah);
481 struct ib_ah *mlx5_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
482 int mlx5_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
483 int mlx5_ib_destroy_ah(struct ib_ah *ah);
484 struct ib_srq *mlx5_ib_create_srq(struct ib_pd *pd,
485                                   struct ib_srq_init_attr *init_attr,
486                                   struct ib_udata *udata);
487 int mlx5_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
488                        enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
489 int mlx5_ib_query_srq(struct ib_srq *ibsrq, struct ib_srq_attr *srq_attr);
490 int mlx5_ib_destroy_srq(struct ib_srq *srq);
491 int mlx5_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
492                           struct ib_recv_wr **bad_wr);
493 struct ib_qp *mlx5_ib_create_qp(struct ib_pd *pd,
494                                 struct ib_qp_init_attr *init_attr,
495                                 struct ib_udata *udata);
496 int mlx5_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
497                       int attr_mask, struct ib_udata *udata);
498 int mlx5_ib_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr, int qp_attr_mask,
499                      struct ib_qp_init_attr *qp_init_attr);
500 int mlx5_ib_destroy_qp(struct ib_qp *qp);
501 int mlx5_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
502                       struct ib_send_wr **bad_wr);
503 int mlx5_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
504                       struct ib_recv_wr **bad_wr);
505 void *mlx5_get_send_wqe(struct mlx5_ib_qp *qp, int n);
506 struct ib_cq *mlx5_ib_create_cq(struct ib_device *ibdev, int entries,
507                                 int vector, struct ib_ucontext *context,
508                                 struct ib_udata *udata);
509 int mlx5_ib_destroy_cq(struct ib_cq *cq);
510 int mlx5_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
511 int mlx5_ib_arm_cq(struct ib_cq *ibcq, enum ib_cq_notify_flags flags);
512 int mlx5_ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
513 int mlx5_ib_resize_cq(struct ib_cq *ibcq, int entries, struct ib_udata *udata);
514 struct ib_mr *mlx5_ib_get_dma_mr(struct ib_pd *pd, int acc);
515 struct ib_mr *mlx5_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
516                                   u64 virt_addr, int access_flags,
517                                   struct ib_udata *udata);
518 int mlx5_ib_dereg_mr(struct ib_mr *ibmr);
519 int mlx5_ib_destroy_mr(struct ib_mr *ibmr);
520 struct ib_mr *mlx5_ib_create_mr(struct ib_pd *pd,
521                                 struct ib_mr_init_attr *mr_init_attr);
522 struct ib_mr *mlx5_ib_alloc_fast_reg_mr(struct ib_pd *pd,
523                                         int max_page_list_len);
524 struct ib_fast_reg_page_list *mlx5_ib_alloc_fast_reg_page_list(struct ib_device *ibdev,
525                                                                int page_list_len);
526 void mlx5_ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
527 struct ib_fmr *mlx5_ib_fmr_alloc(struct ib_pd *pd, int acc,
528                                  struct ib_fmr_attr *fmr_attr);
529 int mlx5_ib_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list,
530                       int npages, u64 iova);
531 int mlx5_ib_unmap_fmr(struct list_head *fmr_list);
532 int mlx5_ib_fmr_dealloc(struct ib_fmr *ibfmr);
533 int mlx5_ib_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num,
534                         struct ib_wc *in_wc, struct ib_grh *in_grh,
535                         struct ib_mad *in_mad, struct ib_mad *out_mad);
536 struct ib_xrcd *mlx5_ib_alloc_xrcd(struct ib_device *ibdev,
537                                           struct ib_ucontext *context,
538                                           struct ib_udata *udata);
539 int mlx5_ib_dealloc_xrcd(struct ib_xrcd *xrcd);
540 int mlx5_vector2eqn(struct mlx5_ib_dev *dev, int vector, int *eqn, int *irqn);
541 int mlx5_ib_get_buf_offset(u64 addr, int page_shift, u32 *offset);
542 int mlx5_query_ext_port_caps(struct mlx5_ib_dev *dev, u8 port);
543 int mlx5_ib_query_port(struct ib_device *ibdev, u8 port,
544                        struct ib_port_attr *props);
545 int mlx5_ib_init_fmr(struct mlx5_ib_dev *dev);
546 void mlx5_ib_cleanup_fmr(struct mlx5_ib_dev *dev);
547 void mlx5_ib_cont_pages(struct ib_umem *umem, u64 addr, int *count, int *shift,
548                         int *ncont, int *order);
549 void mlx5_ib_populate_pas(struct mlx5_ib_dev *dev, struct ib_umem *umem,
550                           int page_shift, __be64 *pas, int umr);
551 void mlx5_ib_copy_pas(u64 *old, u64 *new, int step, int num);
552 int mlx5_ib_get_cqe_size(struct mlx5_ib_dev *dev, struct ib_cq *ibcq);
553 int mlx5_mr_cache_init(struct mlx5_ib_dev *dev);
554 int mlx5_mr_cache_cleanup(struct mlx5_ib_dev *dev);
555 int mlx5_mr_ib_cont_pages(struct ib_umem *umem, u64 addr, int *count, int *shift);
556 void mlx5_umr_cq_handler(struct ib_cq *cq, void *cq_context);
557 int mlx5_ib_check_mr_status(struct ib_mr *ibmr, u32 check_mask,
558                             struct ib_mr_status *mr_status);
559
560 static inline void init_query_mad(struct ib_smp *mad)
561 {
562         mad->base_version  = 1;
563         mad->mgmt_class    = IB_MGMT_CLASS_SUBN_LID_ROUTED;
564         mad->class_version = 1;
565         mad->method        = IB_MGMT_METHOD_GET;
566 }
567
568 static inline u8 convert_access(int acc)
569 {
570         return (acc & IB_ACCESS_REMOTE_ATOMIC ? MLX5_PERM_ATOMIC       : 0) |
571                (acc & IB_ACCESS_REMOTE_WRITE  ? MLX5_PERM_REMOTE_WRITE : 0) |
572                (acc & IB_ACCESS_REMOTE_READ   ? MLX5_PERM_REMOTE_READ  : 0) |
573                (acc & IB_ACCESS_LOCAL_WRITE   ? MLX5_PERM_LOCAL_WRITE  : 0) |
574                MLX5_PERM_LOCAL_READ;
575 }
576
577 #endif /* MLX5_IB_H */