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/rdma_vt.h>
49 #include <rdma/rdmavt_cq.h>
50 
51 struct qib_ctxtdata;
52 struct qib_pportdata;
53 struct qib_devdata;
54 struct qib_verbs_txreq;
55 
56 #define QIB_MAX_RDMA_ATOMIC     16
57 #define QIB_GUIDS_PER_PORT	5
58 #define QIB_PSN_SHIFT		8
59 
60 /*
61  * Increment this value if any changes that break userspace ABI
62  * compatibility are made.
63  */
64 #define QIB_UVERBS_ABI_VERSION       2
65 
66 #define IB_SEQ_NAK	(3 << 29)
67 
68 /* AETH NAK opcode values */
69 #define IB_RNR_NAK                      0x20
70 #define IB_NAK_PSN_ERROR                0x60
71 #define IB_NAK_INVALID_REQUEST          0x61
72 #define IB_NAK_REMOTE_ACCESS_ERROR      0x62
73 #define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
74 #define IB_NAK_INVALID_RD_REQUEST       0x64
75 
76 /* IB Performance Manager status values */
77 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
78 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
79 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
80 
81 /* Mandatory IB performance counter select values. */
82 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
83 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
84 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
85 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
86 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
87 
88 #define QIB_VENDOR_IPG		cpu_to_be16(0xFFA0)
89 
90 #define IB_BTH_REQ_ACK		(1 << 31)
91 #define IB_BTH_SOLICITED	(1 << 23)
92 #define IB_BTH_MIG_REQ		(1 << 22)
93 
94 /* XXX Should be defined in ib_verbs.h enum ib_port_cap_flags */
95 #define IB_PORT_OTHER_LOCAL_CHANGES_SUP (1 << 26)
96 
97 #define IB_GRH_VERSION		6
98 #define IB_GRH_VERSION_MASK	0xF
99 #define IB_GRH_VERSION_SHIFT	28
100 #define IB_GRH_TCLASS_MASK	0xFF
101 #define IB_GRH_TCLASS_SHIFT	20
102 #define IB_GRH_FLOW_MASK	0xFFFFF
103 #define IB_GRH_FLOW_SHIFT	0
104 #define IB_GRH_NEXT_HDR		0x1B
105 
106 #define IB_DEFAULT_GID_PREFIX	cpu_to_be64(0xfe80000000000000ULL)
107 
108 /* Values for set/get portinfo VLCap OperationalVLs */
109 #define IB_VL_VL0       1
110 #define IB_VL_VL0_1     2
111 #define IB_VL_VL0_3     3
112 #define IB_VL_VL0_7     4
113 #define IB_VL_VL0_14    5
114 
115 static inline int qib_num_vls(int vls)
116 {
117 	switch (vls) {
118 	default:
119 	case IB_VL_VL0:
120 		return 1;
121 	case IB_VL_VL0_1:
122 		return 2;
123 	case IB_VL_VL0_3:
124 		return 4;
125 	case IB_VL_VL0_7:
126 		return 8;
127 	case IB_VL_VL0_14:
128 		return 15;
129 	}
130 }
131 
132 struct ib_reth {
133 	__be64 vaddr;
134 	__be32 rkey;
135 	__be32 length;
136 } __packed;
137 
138 struct ib_atomic_eth {
139 	__be32 vaddr[2];        /* unaligned so access as 2 32-bit words */
140 	__be32 rkey;
141 	__be64 swap_data;
142 	__be64 compare_data;
143 } __packed;
144 
145 struct qib_other_headers {
146 	__be32 bth[3];
147 	union {
148 		struct {
149 			__be32 deth[2];
150 			__be32 imm_data;
151 		} ud;
152 		struct {
153 			struct ib_reth reth;
154 			__be32 imm_data;
155 		} rc;
156 		struct {
157 			__be32 aeth;
158 			__be32 atomic_ack_eth[2];
159 		} at;
160 		__be32 imm_data;
161 		__be32 aeth;
162 		__be32 ieth;
163 		struct ib_atomic_eth atomic_eth;
164 	} u;
165 } __packed;
166 
167 /*
168  * Note that UD packets with a GRH header are 8+40+12+8 = 68 bytes
169  * long (72 w/ imm_data).  Only the first 56 bytes of the IB header
170  * will be in the eager header buffer.  The remaining 12 or 16 bytes
171  * are in the data buffer.
172  */
173 struct qib_ib_header {
174 	__be16 lrh[4];
175 	union {
176 		struct {
177 			struct ib_grh grh;
178 			struct qib_other_headers oth;
179 		} l;
180 		struct qib_other_headers oth;
181 	} u;
182 } __packed;
183 
184 struct qib_pio_header {
185 	__le32 pbc[2];
186 	struct qib_ib_header hdr;
187 } __packed;
188 
189 /*
190  * qib specific data structure that will be hidden from rvt after the queue pair
191  * is made common.
192  */
193 struct qib_qp_priv {
194 	struct qib_ib_header *s_hdr;    /* next packet header to send */
195 	struct list_head iowait;        /* link for wait PIO buf */
196 	atomic_t s_dma_busy;
197 	struct qib_verbs_txreq *s_tx;
198 	struct work_struct s_work;
199 	wait_queue_head_t wait_dma;
200 	struct rvt_qp *owner;
201 };
202 
203 #define QIB_PSN_CREDIT  16
204 
205 struct qib_opcode_stats {
206 	u64 n_packets;          /* number of packets */
207 	u64 n_bytes;            /* total number of bytes */
208 };
209 
210 struct qib_opcode_stats_perctx {
211 	struct qib_opcode_stats stats[128];
212 };
213 
214 struct qib_pma_counters {
215 	u64 n_unicast_xmit;     /* total unicast packets sent */
216 	u64 n_unicast_rcv;      /* total unicast packets received */
217 	u64 n_multicast_xmit;   /* total multicast packets sent */
218 	u64 n_multicast_rcv;    /* total multicast packets received */
219 };
220 
221 struct qib_ibport {
222 	struct rvt_ibport rvp;
223 	struct rvt_ah *smi_ah;
224 	__be64 guids[QIB_GUIDS_PER_PORT	- 1];	/* writable GUIDs */
225 	struct qib_pma_counters __percpu *pmastats;
226 	u64 z_unicast_xmit;     /* starting count for PMA */
227 	u64 z_unicast_rcv;      /* starting count for PMA */
228 	u64 z_multicast_xmit;   /* starting count for PMA */
229 	u64 z_multicast_rcv;    /* starting count for PMA */
230 	u64 z_symbol_error_counter;             /* starting count for PMA */
231 	u64 z_link_error_recovery_counter;      /* starting count for PMA */
232 	u64 z_link_downed_counter;              /* starting count for PMA */
233 	u64 z_port_rcv_errors;                  /* starting count for PMA */
234 	u64 z_port_rcv_remphys_errors;          /* starting count for PMA */
235 	u64 z_port_xmit_discards;               /* starting count for PMA */
236 	u64 z_port_xmit_data;                   /* starting count for PMA */
237 	u64 z_port_rcv_data;                    /* starting count for PMA */
238 	u64 z_port_xmit_packets;                /* starting count for PMA */
239 	u64 z_port_rcv_packets;                 /* starting count for PMA */
240 	u32 z_local_link_integrity_errors;      /* starting count for PMA */
241 	u32 z_excessive_buffer_overrun_errors;  /* starting count for PMA */
242 	u32 z_vl15_dropped;                     /* starting count for PMA */
243 	u8 sl_to_vl[16];
244 };
245 
246 struct qib_ibdev {
247 	struct rvt_dev_info rdi;
248 
249 	struct list_head piowait;       /* list for wait PIO buf */
250 	struct list_head dmawait;	/* list for wait DMA */
251 	struct list_head txwait;        /* list for wait qib_verbs_txreq */
252 	struct list_head memwait;       /* list for wait kernel memory */
253 	struct list_head txreq_free;
254 	struct timer_list mem_timer;
255 	struct qib_pio_header *pio_hdrs;
256 	dma_addr_t pio_hdrs_phys;
257 	u32 qp_rnd; /* random bytes for hash */
258 
259 	u32 n_piowait;
260 	u32 n_txwait;
261 
262 #ifdef CONFIG_DEBUG_FS
263 	/* per HCA debugfs */
264 	struct dentry *qib_ibdev_dbg;
265 #endif
266 };
267 
268 struct qib_verbs_counters {
269 	u64 symbol_error_counter;
270 	u64 link_error_recovery_counter;
271 	u64 link_downed_counter;
272 	u64 port_rcv_errors;
273 	u64 port_rcv_remphys_errors;
274 	u64 port_xmit_discards;
275 	u64 port_xmit_data;
276 	u64 port_rcv_data;
277 	u64 port_xmit_packets;
278 	u64 port_rcv_packets;
279 	u32 local_link_integrity_errors;
280 	u32 excessive_buffer_overrun_errors;
281 	u32 vl15_dropped;
282 };
283 
284 static inline struct qib_ibdev *to_idev(struct ib_device *ibdev)
285 {
286 	struct rvt_dev_info *rdi;
287 
288 	rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
289 	return container_of(rdi, struct qib_ibdev, rdi);
290 }
291 
292 /*
293  * Send if not busy or waiting for I/O and either
294  * a RC response is pending or we can process send work requests.
295  */
296 static inline int qib_send_ok(struct rvt_qp *qp)
297 {
298 	return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
299 		(qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
300 		 !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
301 }
302 
303 void _qib_schedule_send(struct rvt_qp *qp);
304 void qib_schedule_send(struct rvt_qp *qp);
305 
306 static inline int qib_pkey_ok(u16 pkey1, u16 pkey2)
307 {
308 	u16 p1 = pkey1 & 0x7FFF;
309 	u16 p2 = pkey2 & 0x7FFF;
310 
311 	/*
312 	 * Low 15 bits must be non-zero and match, and
313 	 * one of the two must be a full member.
314 	 */
315 	return p1 && p1 == p2 && ((__s16)pkey1 < 0 || (__s16)pkey2 < 0);
316 }
317 
318 void qib_bad_pqkey(struct qib_ibport *ibp, __be16 trap_num, u32 key, u32 sl,
319 		   u32 qp1, u32 qp2, __be16 lid1, __be16 lid2);
320 void qib_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
321 void qib_sys_guid_chg(struct qib_ibport *ibp);
322 void qib_node_desc_chg(struct qib_ibport *ibp);
323 int qib_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num,
324 		    const struct ib_wc *in_wc, const struct ib_grh *in_grh,
325 		    const struct ib_mad_hdr *in, size_t in_mad_size,
326 		    struct ib_mad_hdr *out, size_t *out_mad_size,
327 		    u16 *out_mad_pkey_index);
328 void qib_notify_create_mad_agent(struct rvt_dev_info *rdi, int port_idx);
329 void qib_notify_free_mad_agent(struct rvt_dev_info *rdi, int port_idx);
330 
331 /*
332  * Compare the lower 24 bits of the two values.
333  * Returns an integer <, ==, or > than zero.
334  */
335 static inline int qib_cmp24(u32 a, u32 b)
336 {
337 	return (((int) a) - ((int) b)) << 8;
338 }
339 
340 int qib_snapshot_counters(struct qib_pportdata *ppd, u64 *swords,
341 			  u64 *rwords, u64 *spkts, u64 *rpkts,
342 			  u64 *xmit_wait);
343 
344 int qib_get_counters(struct qib_pportdata *ppd,
345 		     struct qib_verbs_counters *cntrs);
346 
347 __be32 qib_compute_aeth(struct rvt_qp *qp);
348 
349 /*
350  * Functions provided by qib driver for rdmavt to use
351  */
352 unsigned qib_free_all_qps(struct rvt_dev_info *rdi);
353 void *qib_qp_priv_alloc(struct rvt_dev_info *rdi, struct rvt_qp *qp, gfp_t gfp);
354 void qib_qp_priv_free(struct rvt_dev_info *rdi, struct rvt_qp *qp);
355 void qib_notify_qp_reset(struct rvt_qp *qp);
356 int qib_alloc_qpn(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt,
357 		  enum ib_qp_type type, u8 port, gfp_t gfp);
358 
359 #ifdef CONFIG_DEBUG_FS
360 
361 struct qib_qp_iter;
362 
363 struct qib_qp_iter *qib_qp_iter_init(struct qib_ibdev *dev);
364 
365 int qib_qp_iter_next(struct qib_qp_iter *iter);
366 
367 void qib_qp_iter_print(struct seq_file *s, struct qib_qp_iter *iter);
368 
369 #endif
370 
371 void qib_get_credit(struct rvt_qp *qp, u32 aeth);
372 
373 unsigned qib_pkt_delay(u32 plen, u8 snd_mult, u8 rcv_mult);
374 
375 void qib_verbs_sdma_desc_avail(struct qib_pportdata *ppd, unsigned avail);
376 
377 void qib_put_txreq(struct qib_verbs_txreq *tx);
378 
379 int qib_verbs_send(struct rvt_qp *qp, struct qib_ib_header *hdr,
380 		   u32 hdrwords, struct rvt_sge_state *ss, u32 len);
381 
382 void qib_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
383 		  int release);
384 
385 void qib_skip_sge(struct rvt_sge_state *ss, u32 length, int release);
386 
387 void qib_uc_rcv(struct qib_ibport *ibp, struct qib_ib_header *hdr,
388 		int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
389 
390 void qib_rc_rcv(struct qib_ctxtdata *rcd, struct qib_ib_header *hdr,
391 		int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
392 
393 int qib_check_ah(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
394 
395 int qib_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
396 
397 struct ib_ah *qib_create_qp0_ah(struct qib_ibport *ibp, u16 dlid);
398 
399 void qib_rc_rnr_retry(unsigned long arg);
400 
401 void qib_rc_send_complete(struct rvt_qp *qp, struct qib_ib_header *hdr);
402 
403 void qib_rc_error(struct rvt_qp *qp, enum ib_wc_status err);
404 
405 int qib_post_ud_send(struct rvt_qp *qp, struct ib_send_wr *wr);
406 
407 void qib_ud_rcv(struct qib_ibport *ibp, struct qib_ib_header *hdr,
408 		int has_grh, void *data, u32 tlen, struct rvt_qp *qp);
409 
410 void mr_rcu_callback(struct rcu_head *list);
411 
412 int qib_get_rwqe(struct rvt_qp *qp, int wr_id_only);
413 
414 void qib_migrate_qp(struct rvt_qp *qp);
415 
416 int qib_ruc_check_hdr(struct qib_ibport *ibp, struct qib_ib_header *hdr,
417 		      int has_grh, struct rvt_qp *qp, u32 bth0);
418 
419 u32 qib_make_grh(struct qib_ibport *ibp, struct ib_grh *hdr,
420 		 struct ib_global_route *grh, u32 hwords, u32 nwords);
421 
422 void qib_make_ruc_header(struct rvt_qp *qp, struct qib_other_headers *ohdr,
423 			 u32 bth0, u32 bth2);
424 
425 void _qib_do_send(struct work_struct *work);
426 
427 void qib_do_send(struct rvt_qp *qp);
428 
429 void qib_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
430 		       enum ib_wc_status status);
431 
432 void qib_send_rc_ack(struct rvt_qp *qp);
433 
434 int qib_make_rc_req(struct rvt_qp *qp, unsigned long *flags);
435 
436 int qib_make_uc_req(struct rvt_qp *qp, unsigned long *flags);
437 
438 int qib_make_ud_req(struct rvt_qp *qp, unsigned long *flags);
439 
440 int qib_register_ib_device(struct qib_devdata *);
441 
442 void qib_unregister_ib_device(struct qib_devdata *);
443 
444 void qib_ib_rcv(struct qib_ctxtdata *, void *, void *, u32);
445 
446 void qib_ib_piobufavail(struct qib_devdata *);
447 
448 unsigned qib_get_npkeys(struct qib_devdata *);
449 
450 unsigned qib_get_pkey(struct qib_ibport *, unsigned);
451 
452 extern const enum ib_wc_opcode ib_qib_wc_opcode[];
453 
454 /*
455  * Below  HCA-independent IB PhysPortState values, returned
456  * by the f_ibphys_portstate() routine.
457  */
458 #define IB_PHYSPORTSTATE_SLEEP 1
459 #define IB_PHYSPORTSTATE_POLL 2
460 #define IB_PHYSPORTSTATE_DISABLED 3
461 #define IB_PHYSPORTSTATE_CFG_TRAIN 4
462 #define IB_PHYSPORTSTATE_LINKUP 5
463 #define IB_PHYSPORTSTATE_LINK_ERR_RECOVER 6
464 #define IB_PHYSPORTSTATE_CFG_DEBOUNCE 8
465 #define IB_PHYSPORTSTATE_CFG_IDLE 0xB
466 #define IB_PHYSPORTSTATE_RECOVERY_RETRAIN 0xC
467 #define IB_PHYSPORTSTATE_RECOVERY_WAITRMT 0xE
468 #define IB_PHYSPORTSTATE_RECOVERY_IDLE 0xF
469 #define IB_PHYSPORTSTATE_CFG_ENH 0x10
470 #define IB_PHYSPORTSTATE_CFG_WAIT_ENH 0x13
471 
472 extern const int ib_rvt_state_ops[];
473 
474 extern __be64 ib_qib_sys_image_guid;    /* in network order */
475 
476 extern unsigned int ib_rvt_lkey_table_size;
477 
478 extern unsigned int ib_qib_max_cqes;
479 
480 extern unsigned int ib_qib_max_cqs;
481 
482 extern unsigned int ib_qib_max_qp_wrs;
483 
484 extern unsigned int ib_qib_max_qps;
485 
486 extern unsigned int ib_qib_max_sges;
487 
488 extern unsigned int ib_qib_max_mcast_grps;
489 
490 extern unsigned int ib_qib_max_mcast_qp_attached;
491 
492 extern unsigned int ib_qib_max_srqs;
493 
494 extern unsigned int ib_qib_max_srq_sges;
495 
496 extern unsigned int ib_qib_max_srq_wrs;
497 
498 extern const u32 ib_qib_rnr_table[];
499 
500 extern const struct rvt_operation_params qib_post_parms[];
501 
502 #endif                          /* QIB_VERBS_H */
503