xref: /openbmc/linux/drivers/infiniband/hw/hfi1/verbs.h (revision 0c874100)
1 /*
2  * Copyright(c) 2015 - 2018 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 #define LRH_16B_BYTES (FIELD_SIZEOF(struct hfi1_16b_header, lrh))
109 #define LRH_16B_DWORDS (LRH_16B_BYTES / sizeof(u32))
110 #define LRH_9B_BYTES (FIELD_SIZEOF(struct ib_header, lrh))
111 #define LRH_9B_DWORDS (LRH_9B_BYTES / sizeof(u32))
112 
113 /* 24Bits for qpn, upper 8Bits reserved */
114 struct opa_16b_mgmt {
115 	__be32 dest_qpn;
116 	__be32 src_qpn;
117 };
118 
119 struct hfi1_16b_header {
120 	u32 lrh[4];
121 	union {
122 		struct {
123 			struct ib_grh grh;
124 			struct ib_other_headers oth;
125 		} l;
126 		struct ib_other_headers oth;
127 		struct opa_16b_mgmt mgmt;
128 	} u;
129 } __packed;
130 
131 struct hfi1_opa_header {
132 	union {
133 		struct ib_header ibh; /* 9B header */
134 		struct hfi1_16b_header opah; /* 16B header */
135 	};
136 	u8 hdr_type; /* 9B or 16B */
137 } __packed;
138 
139 struct hfi1_ahg_info {
140 	u32 ahgdesc[2];
141 	u16 tx_flags;
142 	u8 ahgcount;
143 	u8 ahgidx;
144 };
145 
146 struct hfi1_sdma_header {
147 	__le64 pbc;
148 	struct hfi1_opa_header hdr;
149 } __packed;
150 
151 /*
152  * hfi1 specific data structures that will be hidden from rvt after the queue
153  * pair is made common
154  */
155 struct hfi1_qp_priv {
156 	struct hfi1_ahg_info *s_ahg;              /* ahg info for next header */
157 	struct sdma_engine *s_sde;                /* current sde */
158 	struct send_context *s_sendcontext;       /* current sendcontext */
159 	u8 s_sc;		                  /* SC[0..4] for next packet */
160 	struct iowait s_iowait;
161 	struct rvt_qp *owner;
162 	u8 hdr_type; /* 9B or 16B */
163 };
164 
165 /*
166  * This structure is used to hold commonly lookedup and computed values during
167  * the send engine progress.
168  */
169 struct iowait_work;
170 struct hfi1_pkt_state {
171 	struct hfi1_ibdev *dev;
172 	struct hfi1_ibport *ibp;
173 	struct hfi1_pportdata *ppd;
174 	struct verbs_txreq *s_txreq;
175 	struct iowait_work *wait;
176 	unsigned long flags;
177 	unsigned long timeout;
178 	unsigned long timeout_int;
179 	int cpu;
180 	u8 opcode;
181 	bool in_thread;
182 	bool pkts_sent;
183 };
184 
185 #define HFI1_PSN_CREDIT  16
186 
187 struct hfi1_opcode_stats {
188 	u64 n_packets;          /* number of packets */
189 	u64 n_bytes;            /* total number of bytes */
190 };
191 
192 struct hfi1_opcode_stats_perctx {
193 	struct hfi1_opcode_stats stats[256];
194 };
195 
196 static inline void inc_opstats(
197 	u32 tlen,
198 	struct hfi1_opcode_stats *stats)
199 {
200 #ifdef CONFIG_DEBUG_FS
201 	stats->n_bytes += tlen;
202 	stats->n_packets++;
203 #endif
204 }
205 
206 struct hfi1_ibport {
207 	struct rvt_qp __rcu *qp[2];
208 	struct rvt_ibport rvp;
209 
210 	/* the first 16 entries are sl_to_vl for !OPA */
211 	u8 sl_to_sc[32];
212 	u8 sc_to_sl[32];
213 };
214 
215 struct hfi1_ibdev {
216 	struct rvt_dev_info rdi; /* Must be first */
217 
218 	/* QP numbers are shared by all IB ports */
219 	/* protect txwait list */
220 	seqlock_t txwait_lock ____cacheline_aligned_in_smp;
221 	struct list_head txwait;        /* list for wait verbs_txreq */
222 	struct list_head memwait;       /* list for wait kernel memory */
223 	struct kmem_cache *verbs_txreq_cache;
224 	u64 n_txwait;
225 	u64 n_kmem_wait;
226 
227 	/* protect iowait lists */
228 	seqlock_t iowait_lock ____cacheline_aligned_in_smp;
229 	u64 n_piowait;
230 	u64 n_piodrain;
231 	struct timer_list mem_timer;
232 
233 #ifdef CONFIG_DEBUG_FS
234 	/* per HFI debugfs */
235 	struct dentry *hfi1_ibdev_dbg;
236 	/* per HFI symlinks to above */
237 	struct dentry *hfi1_ibdev_link;
238 #ifdef CONFIG_FAULT_INJECTION
239 	struct fault *fault;
240 #endif
241 #endif
242 };
243 
244 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
245 {
246 	struct rvt_dev_info *rdi;
247 
248 	rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
249 	return container_of(rdi, struct hfi1_ibdev, rdi);
250 }
251 
252 static inline struct rvt_qp *iowait_to_qp(struct iowait *s_iowait)
253 {
254 	struct hfi1_qp_priv *priv;
255 
256 	priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
257 	return priv->owner;
258 }
259 
260 /*
261  * This must be called with s_lock held.
262  */
263 void hfi1_bad_pkey(struct hfi1_ibport *ibp, u32 key, u32 sl,
264 		   u32 qp1, u32 qp2, u32 lid1, u32 lid2);
265 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
266 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
267 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
268 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
269 		     const struct ib_wc *in_wc, const struct ib_grh *in_grh,
270 		     const struct ib_mad_hdr *in_mad, size_t in_mad_size,
271 		     struct ib_mad_hdr *out_mad, size_t *out_mad_size,
272 		     u16 *out_mad_pkey_index);
273 
274 /*
275  * The PSN_MASK and PSN_SHIFT allow for
276  * 1) comparing two PSNs
277  * 2) returning the PSN with any upper bits masked
278  * 3) returning the difference between to PSNs
279  *
280  * The number of significant bits in the PSN must
281  * necessarily be at least one bit less than
282  * the container holding the PSN.
283  */
284 #define PSN_MASK 0x7FFFFFFF
285 #define PSN_SHIFT 1
286 #define PSN_MODIFY_MASK 0xFFFFFF
287 
288 /*
289  * Compare two PSNs
290  * Returns an integer <, ==, or > than zero.
291  */
292 static inline int cmp_psn(u32 a, u32 b)
293 {
294 	return (((int)a) - ((int)b)) << PSN_SHIFT;
295 }
296 
297 /*
298  * Return masked PSN
299  */
300 static inline u32 mask_psn(u32 a)
301 {
302 	return a & PSN_MASK;
303 }
304 
305 /*
306  * Return delta between two PSNs
307  */
308 static inline u32 delta_psn(u32 a, u32 b)
309 {
310 	return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
311 }
312 
313 struct verbs_txreq;
314 void hfi1_put_txreq(struct verbs_txreq *tx);
315 
316 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
317 
318 void hfi1_cnp_rcv(struct hfi1_packet *packet);
319 
320 void hfi1_uc_rcv(struct hfi1_packet *packet);
321 
322 void hfi1_rc_rcv(struct hfi1_packet *packet);
323 
324 void hfi1_rc_hdrerr(
325 	struct hfi1_ctxtdata *rcd,
326 	struct hfi1_packet *packet,
327 	struct rvt_qp *qp);
328 
329 u8 ah_to_sc(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr);
330 
331 void hfi1_rc_send_complete(struct rvt_qp *qp, struct hfi1_opa_header *opah);
332 
333 void hfi1_ud_rcv(struct hfi1_packet *packet);
334 
335 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
336 
337 void hfi1_migrate_qp(struct rvt_qp *qp);
338 
339 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
340 			 int attr_mask, struct ib_udata *udata);
341 
342 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
343 		    int attr_mask, struct ib_udata *udata);
344 void hfi1_restart_rc(struct rvt_qp *qp, u32 psn, int wait);
345 int hfi1_setup_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe,
346 		   bool *call_send);
347 
348 extern const u32 rc_only_opcode;
349 extern const u32 uc_only_opcode;
350 
351 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_packet *packet);
352 
353 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
354 		  const struct ib_global_route *grh, u32 hwords, u32 nwords);
355 
356 void hfi1_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
357 			  u32 bth0, u32 bth2, int middle,
358 			  struct hfi1_pkt_state *ps);
359 
360 void _hfi1_do_send(struct work_struct *work);
361 
362 void hfi1_do_send_from_rvt(struct rvt_qp *qp);
363 
364 void hfi1_do_send(struct rvt_qp *qp, bool in_thread);
365 
366 void hfi1_send_rc_ack(struct hfi1_packet *packet, bool is_fecn);
367 
368 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
369 
370 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
371 
372 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
373 
374 int hfi1_register_ib_device(struct hfi1_devdata *);
375 
376 void hfi1_unregister_ib_device(struct hfi1_devdata *);
377 
378 void hfi1_ib_rcv(struct hfi1_packet *packet);
379 
380 void hfi1_16B_rcv(struct hfi1_packet *packet);
381 
382 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
383 
384 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
385 			u64 pbc);
386 
387 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
388 			u64 pbc);
389 
390 static inline bool opa_bth_is_migration(struct ib_other_headers *ohdr)
391 {
392 	return ohdr->bth[1] & cpu_to_be32(OPA_BTH_MIG_REQ);
393 }
394 
395 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
396 
397 extern const u8 hdr_len_by_opcode[];
398 
399 extern const int ib_rvt_state_ops[];
400 
401 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
402 
403 extern unsigned int hfi1_max_cqes;
404 
405 extern unsigned int hfi1_max_cqs;
406 
407 extern unsigned int hfi1_max_qp_wrs;
408 
409 extern unsigned int hfi1_max_qps;
410 
411 extern unsigned int hfi1_max_sges;
412 
413 extern unsigned int hfi1_max_mcast_grps;
414 
415 extern unsigned int hfi1_max_mcast_qp_attached;
416 
417 extern unsigned int hfi1_max_srqs;
418 
419 extern unsigned int hfi1_max_srq_sges;
420 
421 extern unsigned int hfi1_max_srq_wrs;
422 
423 extern unsigned short piothreshold;
424 
425 extern const u32 ib_hfi1_rnr_table[];
426 
427 #endif                          /* HFI1_VERBS_H */
428