drivers/infiniband/hw/hfi1/verbs.h

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