xref: /openbmc/linux/drivers/infiniband/hw/hfi1/verbs.h (revision d3964221)
1 /*
2  * Copyright(c) 2015 - 2017 Intel Corporation.
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * BSD LICENSE
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  *
24  *  - Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  *  - Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *  - Neither the name of Intel Corporation nor the names of its
31  *    contributors may be used to endorse or promote products derived
32  *    from this software without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  */
47 
48 #ifndef HFI1_VERBS_H
49 #define HFI1_VERBS_H
50 
51 #include <linux/types.h>
52 #include <linux/seqlock.h>
53 #include <linux/kernel.h>
54 #include <linux/interrupt.h>
55 #include <linux/kref.h>
56 #include <linux/workqueue.h>
57 #include <linux/kthread.h>
58 #include <linux/completion.h>
59 #include <linux/slab.h>
60 #include <rdma/ib_pack.h>
61 #include <rdma/ib_user_verbs.h>
62 #include <rdma/ib_mad.h>
63 #include <rdma/ib_hdrs.h>
64 #include <rdma/rdma_vt.h>
65 #include <rdma/rdmavt_qp.h>
66 #include <rdma/rdmavt_cq.h>
67 
68 struct hfi1_ctxtdata;
69 struct hfi1_pportdata;
70 struct hfi1_devdata;
71 struct hfi1_packet;
72 
73 #include "iowait.h"
74 
75 #define HFI1_MAX_RDMA_ATOMIC     16
76 
77 /*
78  * Increment this value if any changes that break userspace ABI
79  * compatibility are made.
80  */
81 #define HFI1_UVERBS_ABI_VERSION       2
82 
83 /* IB Performance Manager status values */
84 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
85 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
86 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
87 
88 /* Mandatory IB performance counter select values. */
89 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
90 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
91 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
92 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
93 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
94 
95 #define HFI1_VENDOR_IPG		cpu_to_be16(0xFFA0)
96 
97 #define IB_DEFAULT_GID_PREFIX	cpu_to_be64(0xfe80000000000000ULL)
98 #define OPA_BTH_MIG_REQ		BIT(31)
99 
100 #define RC_OP(x) IB_OPCODE_RC_##x
101 #define UC_OP(x) IB_OPCODE_UC_##x
102 
103 /* flags passed by hfi1_ib_rcv() */
104 enum {
105 	HFI1_HAS_GRH = (1 << 0),
106 };
107 
108 struct hfi1_16b_header {
109 	u32 lrh[4];
110 	union {
111 		struct {
112 			struct ib_grh grh;
113 			struct ib_other_headers oth;
114 		} l;
115 		struct ib_other_headers oth;
116 	} u;
117 } __packed;
118 
119 struct hfi1_opa_header {
120 	union {
121 		struct ib_header ibh; /* 9B header */
122 		struct hfi1_16b_header opah; /* 16B header */
123 	};
124 	u8 hdr_type; /* 9B or 16B */
125 } __packed;
126 
127 struct hfi1_ahg_info {
128 	u32 ahgdesc[2];
129 	u16 tx_flags;
130 	u8 ahgcount;
131 	u8 ahgidx;
132 };
133 
134 struct hfi1_sdma_header {
135 	__le64 pbc;
136 	struct hfi1_opa_header hdr;
137 } __packed;
138 
139 /*
140  * hfi1 specific data structures that will be hidden from rvt after the queue
141  * pair is made common
142  */
143 struct hfi1_qp_priv {
144 	struct hfi1_ahg_info *s_ahg;              /* ahg info for next header */
145 	struct sdma_engine *s_sde;                /* current sde */
146 	struct send_context *s_sendcontext;       /* current sendcontext */
147 	u8 s_sc;		                  /* SC[0..4] for next packet */
148 	struct iowait s_iowait;
149 	struct rvt_qp *owner;
150 	u8 hdr_type; /* 9B or 16B */
151 };
152 
153 /*
154  * This structure is used to hold commonly lookedup and computed values during
155  * the send engine progress.
156  */
157 struct hfi1_pkt_state {
158 	struct hfi1_ibdev *dev;
159 	struct hfi1_ibport *ibp;
160 	struct hfi1_pportdata *ppd;
161 	struct verbs_txreq *s_txreq;
162 	unsigned long flags;
163 	unsigned long timeout;
164 	unsigned long timeout_int;
165 	int cpu;
166 	u8 opcode;
167 	bool in_thread;
168 	bool pkts_sent;
169 };
170 
171 #define HFI1_PSN_CREDIT  16
172 
173 struct hfi1_opcode_stats {
174 	u64 n_packets;          /* number of packets */
175 	u64 n_bytes;            /* total number of bytes */
176 };
177 
178 struct hfi1_opcode_stats_perctx {
179 	struct hfi1_opcode_stats stats[256];
180 };
181 
182 static inline void inc_opstats(
183 	u32 tlen,
184 	struct hfi1_opcode_stats *stats)
185 {
186 #ifdef CONFIG_DEBUG_FS
187 	stats->n_bytes += tlen;
188 	stats->n_packets++;
189 #endif
190 }
191 
192 struct hfi1_ibport {
193 	struct rvt_qp __rcu *qp[2];
194 	struct rvt_ibport rvp;
195 
196 	/* the first 16 entries are sl_to_vl for !OPA */
197 	u8 sl_to_sc[32];
198 	u8 sc_to_sl[32];
199 };
200 
201 struct hfi1_ibdev {
202 	struct rvt_dev_info rdi; /* Must be first */
203 
204 	/* QP numbers are shared by all IB ports */
205 	/* protect txwait list */
206 	seqlock_t txwait_lock ____cacheline_aligned_in_smp;
207 	struct list_head txwait;        /* list for wait verbs_txreq */
208 	struct list_head memwait;       /* list for wait kernel memory */
209 	struct kmem_cache *verbs_txreq_cache;
210 	u64 n_txwait;
211 	u64 n_kmem_wait;
212 
213 	/* protect iowait lists */
214 	seqlock_t iowait_lock ____cacheline_aligned_in_smp;
215 	u64 n_piowait;
216 	u64 n_piodrain;
217 	struct timer_list mem_timer;
218 
219 #ifdef CONFIG_DEBUG_FS
220 	/* per HFI debugfs */
221 	struct dentry *hfi1_ibdev_dbg;
222 	/* per HFI symlinks to above */
223 	struct dentry *hfi1_ibdev_link;
224 #ifdef CONFIG_FAULT_INJECTION
225 	struct fault_opcode *fault_opcode;
226 	struct fault_packet *fault_packet;
227 	bool fault_suppress_err;
228 #endif
229 #endif
230 };
231 
232 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
233 {
234 	struct rvt_dev_info *rdi;
235 
236 	rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
237 	return container_of(rdi, struct hfi1_ibdev, rdi);
238 }
239 
240 static inline struct rvt_qp *iowait_to_qp(struct  iowait *s_iowait)
241 {
242 	struct hfi1_qp_priv *priv;
243 
244 	priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
245 	return priv->owner;
246 }
247 
248 /*
249  * Send if not busy or waiting for I/O and either
250  * a RC response is pending or we can process send work requests.
251  */
252 static inline int hfi1_send_ok(struct rvt_qp *qp)
253 {
254 	return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
255 		(qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
256 		 !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
257 }
258 
259 /*
260  * This must be called with s_lock held.
261  */
262 void hfi1_bad_pkey(struct hfi1_ibport *ibp, u32 key, u32 sl,
263 		   u32 qp1, u32 qp2, u32 lid1, u32 lid2);
264 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
265 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
266 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
267 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
268 		     const struct ib_wc *in_wc, const struct ib_grh *in_grh,
269 		     const struct ib_mad_hdr *in_mad, size_t in_mad_size,
270 		     struct ib_mad_hdr *out_mad, size_t *out_mad_size,
271 		     u16 *out_mad_pkey_index);
272 
273 /*
274  * The PSN_MASK and PSN_SHIFT allow for
275  * 1) comparing two PSNs
276  * 2) returning the PSN with any upper bits masked
277  * 3) returning the difference between to PSNs
278  *
279  * The number of significant bits in the PSN must
280  * necessarily be at least one bit less than
281  * the container holding the PSN.
282  */
283 #define PSN_MASK 0x7FFFFFFF
284 #define PSN_SHIFT 1
285 #define PSN_MODIFY_MASK 0xFFFFFF
286 
287 /*
288  * Compare two PSNs
289  * Returns an integer <, ==, or > than zero.
290  */
291 static inline int cmp_psn(u32 a, u32 b)
292 {
293 	return (((int)a) - ((int)b)) << PSN_SHIFT;
294 }
295 
296 /*
297  * Return masked PSN
298  */
299 static inline u32 mask_psn(u32 a)
300 {
301 	return a & PSN_MASK;
302 }
303 
304 /*
305  * Return delta between two PSNs
306  */
307 static inline u32 delta_psn(u32 a, u32 b)
308 {
309 	return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
310 }
311 
312 struct verbs_txreq;
313 void hfi1_put_txreq(struct verbs_txreq *tx);
314 
315 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
316 
317 void hfi1_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
318 		   bool release, bool copy_last);
319 
320 void hfi1_cnp_rcv(struct hfi1_packet *packet);
321 
322 void hfi1_uc_rcv(struct hfi1_packet *packet);
323 
324 void hfi1_rc_rcv(struct hfi1_packet *packet);
325 
326 void hfi1_rc_hdrerr(
327 	struct hfi1_ctxtdata *rcd,
328 	struct hfi1_packet *packet,
329 	struct rvt_qp *qp);
330 
331 u8 ah_to_sc(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr);
332 
333 void hfi1_rc_send_complete(struct rvt_qp *qp, struct hfi1_opa_header *opah);
334 
335 void hfi1_ud_rcv(struct hfi1_packet *packet);
336 
337 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
338 
339 int hfi1_rvt_get_rwqe(struct rvt_qp *qp, int wr_id_only);
340 
341 void hfi1_migrate_qp(struct rvt_qp *qp);
342 
343 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
344 			 int attr_mask, struct ib_udata *udata);
345 
346 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
347 		    int attr_mask, struct ib_udata *udata);
348 void hfi1_restart_rc(struct rvt_qp *qp, u32 psn, int wait);
349 int hfi1_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
350 
351 extern const u32 rc_only_opcode;
352 extern const u32 uc_only_opcode;
353 
354 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_packet *packet);
355 
356 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
357 		  const struct ib_global_route *grh, u32 hwords, u32 nwords);
358 
359 void hfi1_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
360 			  u32 bth0, u32 bth2, int middle,
361 			  struct hfi1_pkt_state *ps);
362 
363 void _hfi1_do_send(struct work_struct *work);
364 
365 void hfi1_do_send_from_rvt(struct rvt_qp *qp);
366 
367 void hfi1_do_send(struct rvt_qp *qp, bool in_thread);
368 
369 void hfi1_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
370 			enum ib_wc_status status);
371 
372 void hfi1_send_rc_ack(struct hfi1_ctxtdata *rcd, struct rvt_qp *qp,
373 		      bool is_fecn);
374 
375 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
376 
377 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
378 
379 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
380 
381 int hfi1_register_ib_device(struct hfi1_devdata *);
382 
383 void hfi1_unregister_ib_device(struct hfi1_devdata *);
384 
385 void hfi1_ib_rcv(struct hfi1_packet *packet);
386 
387 void hfi1_16B_rcv(struct hfi1_packet *packet);
388 
389 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
390 
391 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
392 			u64 pbc);
393 
394 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
395 			u64 pbc);
396 
397 int hfi1_wss_init(void);
398 void hfi1_wss_exit(void);
399 
400 /* platform specific: return the lowest level cache (llc) size, in KiB */
401 static inline int wss_llc_size(void)
402 {
403 	/* assume that the boot CPU value is universal for all CPUs */
404 	return boot_cpu_data.x86_cache_size;
405 }
406 
407 /* platform specific: cacheless copy */
408 static inline void cacheless_memcpy(void *dst, void *src, size_t n)
409 {
410 	/*
411 	 * Use the only available X64 cacheless copy.  Add a __user cast
412 	 * to quiet sparse.  The src agument is already in the kernel so
413 	 * there are no security issues.  The extra fault recovery machinery
414 	 * is not invoked.
415 	 */
416 	__copy_user_nocache(dst, (void __user *)src, n, 0);
417 }
418 
419 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
420 
421 extern const u8 hdr_len_by_opcode[];
422 
423 extern const int ib_rvt_state_ops[];
424 
425 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
426 
427 extern unsigned int hfi1_max_cqes;
428 
429 extern unsigned int hfi1_max_cqs;
430 
431 extern unsigned int hfi1_max_qp_wrs;
432 
433 extern unsigned int hfi1_max_qps;
434 
435 extern unsigned int hfi1_max_sges;
436 
437 extern unsigned int hfi1_max_mcast_grps;
438 
439 extern unsigned int hfi1_max_mcast_qp_attached;
440 
441 extern unsigned int hfi1_max_srqs;
442 
443 extern unsigned int hfi1_max_srq_sges;
444 
445 extern unsigned int hfi1_max_srq_wrs;
446 
447 extern unsigned short piothreshold;
448 
449 extern const u32 ib_hfi1_rnr_table[];
450 
451 #endif                          /* HFI1_VERBS_H */
452