GNU Linux-libre 4.9.287-gnu1
[releases.git] / drivers / infiniband / hw / qib / qib_verbs.h
1 /*
2  * Copyright (c) 2012, 2013 Intel Corporation.  All rights reserved.
3  * Copyright (c) 2006 - 2012 QLogic Corporation. All rights reserved.
4  * Copyright (c) 2005, 2006 PathScale, Inc. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34
35 #ifndef QIB_VERBS_H
36 #define QIB_VERBS_H
37
38 #include <linux/types.h>
39 #include <linux/spinlock.h>
40 #include <linux/kernel.h>
41 #include <linux/interrupt.h>
42 #include <linux/kref.h>
43 #include <linux/workqueue.h>
44 #include <linux/kthread.h>
45 #include <linux/completion.h>
46 #include <rdma/ib_pack.h>
47 #include <rdma/ib_user_verbs.h>
48 #include <rdma/ib_hdrs.h>
49 #include <rdma/rdma_vt.h>
50 #include <rdma/rdmavt_cq.h>
51
52 struct qib_ctxtdata;
53 struct qib_pportdata;
54 struct qib_devdata;
55 struct qib_verbs_txreq;
56
57 #define QIB_MAX_RDMA_ATOMIC     16
58 #define QIB_GUIDS_PER_PORT      5
59 #define QIB_PSN_SHIFT           8
60
61 /*
62  * Increment this value if any changes that break userspace ABI
63  * compatibility are made.
64  */
65 #define QIB_UVERBS_ABI_VERSION       2
66
67 /* IB Performance Manager status values */
68 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
69 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
70 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
71
72 /* Mandatory IB performance counter select values. */
73 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
74 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
75 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
76 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
77 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
78
79 #define QIB_VENDOR_IPG          cpu_to_be16(0xFFA0)
80
81 /* XXX Should be defined in ib_verbs.h enum ib_port_cap_flags */
82 #define IB_PORT_OTHER_LOCAL_CHANGES_SUP (1 << 26)
83
84 #define IB_DEFAULT_GID_PREFIX   cpu_to_be64(0xfe80000000000000ULL)
85
86 /* Values for set/get portinfo VLCap OperationalVLs */
87 #define IB_VL_VL0       1
88 #define IB_VL_VL0_1     2
89 #define IB_VL_VL0_3     3
90 #define IB_VL_VL0_7     4
91 #define IB_VL_VL0_14    5
92
93 static inline int qib_num_vls(int vls)
94 {
95         switch (vls) {
96         default:
97         case IB_VL_VL0:
98                 return 1;
99         case IB_VL_VL0_1:
100                 return 2;
101         case IB_VL_VL0_3:
102                 return 4;
103         case IB_VL_VL0_7:
104                 return 8;
105         case IB_VL_VL0_14:
106                 return 15;
107         }
108 }
109
110 struct qib_pio_header {
111         __le32 pbc[2];
112         struct ib_header hdr;
113 } __packed;
114
115 /*
116  * qib specific data structure that will be hidden from rvt after the queue pair
117  * is made common.
118  */
119 struct qib_qp_priv {
120         struct ib_header *s_hdr;        /* next packet header to send */
121         struct list_head iowait;        /* link for wait PIO buf */
122         atomic_t s_dma_busy;
123         struct qib_verbs_txreq *s_tx;
124         struct work_struct s_work;
125         wait_queue_head_t wait_dma;
126         struct rvt_qp *owner;
127 };
128
129 #define QIB_PSN_CREDIT  16
130
131 struct qib_opcode_stats {
132         u64 n_packets;          /* number of packets */
133         u64 n_bytes;            /* total number of bytes */
134 };
135
136 struct qib_opcode_stats_perctx {
137         struct qib_opcode_stats stats[128];
138 };
139
140 struct qib_pma_counters {
141         u64 n_unicast_xmit;     /* total unicast packets sent */
142         u64 n_unicast_rcv;      /* total unicast packets received */
143         u64 n_multicast_xmit;   /* total multicast packets sent */
144         u64 n_multicast_rcv;    /* total multicast packets received */
145 };
146
147 struct qib_ibport {
148         struct rvt_ibport rvp;
149         struct rvt_ah *smi_ah;
150         __be64 guids[QIB_GUIDS_PER_PORT - 1];   /* writable GUIDs */
151         struct qib_pma_counters __percpu *pmastats;
152         u64 z_unicast_xmit;     /* starting count for PMA */
153         u64 z_unicast_rcv;      /* starting count for PMA */
154         u64 z_multicast_xmit;   /* starting count for PMA */
155         u64 z_multicast_rcv;    /* starting count for PMA */
156         u64 z_symbol_error_counter;             /* starting count for PMA */
157         u64 z_link_error_recovery_counter;      /* starting count for PMA */
158         u64 z_link_downed_counter;              /* starting count for PMA */
159         u64 z_port_rcv_errors;                  /* starting count for PMA */
160         u64 z_port_rcv_remphys_errors;          /* starting count for PMA */
161         u64 z_port_xmit_discards;               /* starting count for PMA */
162         u64 z_port_xmit_data;                   /* starting count for PMA */
163         u64 z_port_rcv_data;                    /* starting count for PMA */
164         u64 z_port_xmit_packets;                /* starting count for PMA */
165         u64 z_port_rcv_packets;                 /* starting count for PMA */
166         u32 z_local_link_integrity_errors;      /* starting count for PMA */
167         u32 z_excessive_buffer_overrun_errors;  /* starting count for PMA */
168         u32 z_vl15_dropped;                     /* starting count for PMA */
169         u8 sl_to_vl[16];
170 };
171
172 struct qib_ibdev {
173         struct rvt_dev_info rdi;
174
175         struct list_head piowait;       /* list for wait PIO buf */
176         struct list_head dmawait;       /* list for wait DMA */
177         struct list_head txwait;        /* list for wait qib_verbs_txreq */
178         struct list_head memwait;       /* list for wait kernel memory */
179         struct list_head txreq_free;
180         struct timer_list mem_timer;
181         struct qib_pio_header *pio_hdrs;
182         dma_addr_t pio_hdrs_phys;
183         u32 qp_rnd; /* random bytes for hash */
184
185         u32 n_piowait;
186         u32 n_txwait;
187
188 #ifdef CONFIG_DEBUG_FS
189         /* per HCA debugfs */
190         struct dentry *qib_ibdev_dbg;
191 #endif
192 };
193
194 struct qib_verbs_counters {
195         u64 symbol_error_counter;
196         u64 link_error_recovery_counter;
197         u64 link_downed_counter;
198         u64 port_rcv_errors;
199         u64 port_rcv_remphys_errors;
200         u64 port_xmit_discards;
201         u64 port_xmit_data;
202         u64 port_rcv_data;
203         u64 port_xmit_packets;
204         u64 port_rcv_packets;
205         u32 local_link_integrity_errors;
206         u32 excessive_buffer_overrun_errors;
207         u32 vl15_dropped;
208 };
209
210 static inline struct qib_ibdev *to_idev(struct ib_device *ibdev)
211 {
212         struct rvt_dev_info *rdi;
213
214         rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
215         return container_of(rdi, struct qib_ibdev, rdi);
216 }
217
218 /*
219  * Send if not busy or waiting for I/O and either
220  * a RC response is pending or we can process send work requests.
221  */
222 static inline int qib_send_ok(struct rvt_qp *qp)
223 {
224         return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
225                 (qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
226                  !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
227 }
228
229 void _qib_schedule_send(struct rvt_qp *qp);
230 void qib_schedule_send(struct rvt_qp *qp);
231
232 static inline int qib_pkey_ok(u16 pkey1, u16 pkey2)
233 {
234         u16 p1 = pkey1 & 0x7FFF;
235         u16 p2 = pkey2 & 0x7FFF;
236
237         /*
238          * Low 15 bits must be non-zero and match, and
239          * one of the two must be a full member.
240          */
241         return p1 && p1 == p2 && ((__s16)pkey1 < 0 || (__s16)pkey2 < 0);
242 }
243
244 void qib_bad_pqkey(struct qib_ibport *ibp, __be16 trap_num, u32 key, u32 sl,
245                    u32 qp1, u32 qp2, __be16 lid1, __be16 lid2);
246 void qib_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
247 void qib_sys_guid_chg(struct qib_ibport *ibp);
248 void qib_node_desc_chg(struct qib_ibport *ibp);
249 int qib_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num,
250                     const struct ib_wc *in_wc, const struct ib_grh *in_grh,
251                     const struct ib_mad_hdr *in, size_t in_mad_size,
252                     struct ib_mad_hdr *out, size_t *out_mad_size,
253                     u16 *out_mad_pkey_index);
254 void qib_notify_create_mad_agent(struct rvt_dev_info *rdi, int port_idx);
255 void qib_notify_free_mad_agent(struct rvt_dev_info *rdi, int port_idx);
256
257 /*
258  * Compare the lower 24 bits of the two values.
259  * Returns an integer <, ==, or > than zero.
260  */
261 static inline int qib_cmp24(u32 a, u32 b)
262 {
263         return (((int) a) - ((int) b)) << 8;
264 }
265
266 int qib_snapshot_counters(struct qib_pportdata *ppd, u64 *swords,
267                           u64 *rwords, u64 *spkts, u64 *rpkts,
268                           u64 *xmit_wait);
269
270 int qib_get_counters(struct qib_pportdata *ppd,
271                      struct qib_verbs_counters *cntrs);
272
273 __be32 qib_compute_aeth(struct rvt_qp *qp);
274
275 /*
276  * Functions provided by qib driver for rdmavt to use
277  */
278 unsigned qib_free_all_qps(struct rvt_dev_info *rdi);
279 void *qib_qp_priv_alloc(struct rvt_dev_info *rdi, struct rvt_qp *qp, gfp_t gfp);
280 void qib_qp_priv_free(struct rvt_dev_info *rdi, struct rvt_qp *qp);
281 void qib_notify_qp_reset(struct rvt_qp *qp);
282 int qib_alloc_qpn(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt,
283                   enum ib_qp_type type, u8 port, gfp_t gfp);
284
285 #ifdef CONFIG_DEBUG_FS
286
287 struct qib_qp_iter;
288
289 struct qib_qp_iter *qib_qp_iter_init(struct qib_ibdev *dev);
290
291 int qib_qp_iter_next(struct qib_qp_iter *iter);
292
293 void qib_qp_iter_print(struct seq_file *s, struct qib_qp_iter *iter);
294
295 #endif
296
297 void qib_get_credit(struct rvt_qp *qp, u32 aeth);
298
299 unsigned qib_pkt_delay(u32 plen, u8 snd_mult, u8 rcv_mult);
300
301 void qib_verbs_sdma_desc_avail(struct qib_pportdata *ppd, unsigned avail);
302
303 void qib_put_txreq(struct qib_verbs_txreq *tx);
304
305 int qib_verbs_send(struct rvt_qp *qp, struct ib_header *hdr,
306                    u32 hdrwords, struct rvt_sge_state *ss, u32 len);
307
308 void qib_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
309                   int release);
310
311 void qib_skip_sge(struct rvt_sge_state *ss, u32 length, int release);
312
313 void qib_uc_rcv(struct qib_ibport *ibp, struct ib_header *hdr,
314                 int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
315
316 void qib_rc_rcv(struct qib_ctxtdata *rcd, struct ib_header *hdr,
317                 int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
318
319 int qib_check_ah(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
320
321 int qib_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
322
323 struct ib_ah *qib_create_qp0_ah(struct qib_ibport *ibp, u16 dlid);
324
325 void qib_rc_rnr_retry(unsigned long arg);
326
327 void qib_rc_send_complete(struct rvt_qp *qp, struct ib_header *hdr);
328
329 void qib_rc_error(struct rvt_qp *qp, enum ib_wc_status err);
330
331 int qib_post_ud_send(struct rvt_qp *qp, struct ib_send_wr *wr);
332
333 void qib_ud_rcv(struct qib_ibport *ibp, struct ib_header *hdr,
334                 int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
335
336 void mr_rcu_callback(struct rcu_head *list);
337
338 int qib_get_rwqe(struct rvt_qp *qp, int wr_id_only);
339
340 void qib_migrate_qp(struct rvt_qp *qp);
341
342 int qib_ruc_check_hdr(struct qib_ibport *ibp, struct ib_header *hdr,
343                       int has_grh, struct rvt_qp *qp, u32 bth0);
344
345 u32 qib_make_grh(struct qib_ibport *ibp, struct ib_grh *hdr,
346                  struct ib_global_route *grh, u32 hwords, u32 nwords);
347
348 void qib_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
349                          u32 bth0, u32 bth2);
350
351 void _qib_do_send(struct work_struct *work);
352
353 void qib_do_send(struct rvt_qp *qp);
354
355 void qib_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
356                        enum ib_wc_status status);
357
358 void qib_send_rc_ack(struct rvt_qp *qp);
359
360 int qib_make_rc_req(struct rvt_qp *qp, unsigned long *flags);
361
362 int qib_make_uc_req(struct rvt_qp *qp, unsigned long *flags);
363
364 int qib_make_ud_req(struct rvt_qp *qp, unsigned long *flags);
365
366 int qib_register_ib_device(struct qib_devdata *);
367
368 void qib_unregister_ib_device(struct qib_devdata *);
369
370 void qib_ib_rcv(struct qib_ctxtdata *, void *, void *, u32);
371
372 void qib_ib_piobufavail(struct qib_devdata *);
373
374 unsigned qib_get_npkeys(struct qib_devdata *);
375
376 unsigned qib_get_pkey(struct qib_ibport *, unsigned);
377
378 extern const enum ib_wc_opcode ib_qib_wc_opcode[];
379
380 /*
381  * Below  HCA-independent IB PhysPortState values, returned
382  * by the f_ibphys_portstate() routine.
383  */
384 #define IB_PHYSPORTSTATE_SLEEP 1
385 #define IB_PHYSPORTSTATE_POLL 2
386 #define IB_PHYSPORTSTATE_DISABLED 3
387 #define IB_PHYSPORTSTATE_CFG_TRAIN 4
388 #define IB_PHYSPORTSTATE_LINKUP 5
389 #define IB_PHYSPORTSTATE_LINK_ERR_RECOVER 6
390 #define IB_PHYSPORTSTATE_CFG_DEBOUNCE 8
391 #define IB_PHYSPORTSTATE_CFG_IDLE 0xB
392 #define IB_PHYSPORTSTATE_RECOVERY_RETRAIN 0xC
393 #define IB_PHYSPORTSTATE_RECOVERY_WAITRMT 0xE
394 #define IB_PHYSPORTSTATE_RECOVERY_IDLE 0xF
395 #define IB_PHYSPORTSTATE_CFG_ENH 0x10
396 #define IB_PHYSPORTSTATE_CFG_WAIT_ENH 0x13
397
398 extern const int ib_rvt_state_ops[];
399
400 extern __be64 ib_qib_sys_image_guid;    /* in network order */
401
402 extern unsigned int ib_rvt_lkey_table_size;
403
404 extern unsigned int ib_qib_max_cqes;
405
406 extern unsigned int ib_qib_max_cqs;
407
408 extern unsigned int ib_qib_max_qp_wrs;
409
410 extern unsigned int ib_qib_max_qps;
411
412 extern unsigned int ib_qib_max_sges;
413
414 extern unsigned int ib_qib_max_mcast_grps;
415
416 extern unsigned int ib_qib_max_mcast_qp_attached;
417
418 extern unsigned int ib_qib_max_srqs;
419
420 extern unsigned int ib_qib_max_srq_sges;
421
422 extern unsigned int ib_qib_max_srq_wrs;
423
424 extern const u32 ib_qib_rnr_table[];
425
426 extern const struct rvt_operation_params qib_post_parms[];
427
428 #endif                          /* QIB_VERBS_H */