drivers/staging/rdma/hfi1/verbs.h

   1 /*
   2  * Copyright(c) 2015, 2016 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/rdma_vt.h>
  64 #include <rdma/rdmavt_qp.h>
  65 #include <rdma/rdmavt_cq.h>
  66
  67 struct hfi1_ctxtdata;
  68 struct hfi1_pportdata;
  69 struct hfi1_devdata;
  70 struct hfi1_packet;
  71
  72 #include "iowait.h"
  73
  74 #define HFI1_MAX_RDMA_ATOMIC     16
  75 #define HFI1_GUIDS_PER_PORT     5
  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 #define IB_SEQ_NAK      (3 << 29)
  84
  85 /* AETH NAK opcode values */
  86 #define IB_RNR_NAK                      0x20
  87 #define IB_NAK_PSN_ERROR                0x60
  88 #define IB_NAK_INVALID_REQUEST          0x61
  89 #define IB_NAK_REMOTE_ACCESS_ERROR      0x62
  90 #define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
  91 #define IB_NAK_INVALID_RD_REQUEST       0x64
  92
  93 /* IB Performance Manager status values */
  94 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
  95 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
  96 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
  97
  98 /* Mandatory IB performance counter select values. */
  99 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
 100 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
 101 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
 102 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
 103 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
 104
 105 #define HFI1_VENDOR_IPG         cpu_to_be16(0xFFA0)
 106
 107 #define IB_BTH_REQ_ACK          BIT(31)
 108 #define IB_BTH_SOLICITED        BIT(23)
 109 #define IB_BTH_MIG_REQ          BIT(22)
 110
 111 #define IB_GRH_VERSION          6
 112 #define IB_GRH_VERSION_MASK     0xF
 113 #define IB_GRH_VERSION_SHIFT    28
 114 #define IB_GRH_TCLASS_MASK      0xFF
 115 #define IB_GRH_TCLASS_SHIFT     20
 116 #define IB_GRH_FLOW_MASK        0xFFFFF
 117 #define IB_GRH_FLOW_SHIFT       0
 118 #define IB_GRH_NEXT_HDR         0x1B
 119
 120 #define IB_DEFAULT_GID_PREFIX   cpu_to_be64(0xfe80000000000000ULL)
 121
 122 /* flags passed by hfi1_ib_rcv() */
 123 enum {
 124         HFI1_HAS_GRH = (1 << 0),
 125 };
 126
 127 struct ib_reth {
 128         __be64 vaddr;
 129         __be32 rkey;
 130         __be32 length;
 131 } __packed;
 132
 133 struct ib_atomic_eth {
 134         __be32 vaddr[2];        /* unaligned so access as 2 32-bit words */
 135         __be32 rkey;
 136         __be64 swap_data;
 137         __be64 compare_data;
 138 } __packed;
 139
 140 union ib_ehdrs {
 141         struct {
 142                 __be32 deth[2];
 143                 __be32 imm_data;
 144         } ud;
 145         struct {
 146                 struct ib_reth reth;
 147                 __be32 imm_data;
 148         } rc;
 149         struct {
 150                 __be32 aeth;
 151                 __be32 atomic_ack_eth[2];
 152         } at;
 153         __be32 imm_data;
 154         __be32 aeth;
 155         struct ib_atomic_eth atomic_eth;
 156 }  __packed;
 157
 158 struct hfi1_other_headers {
 159         __be32 bth[3];
 160         union ib_ehdrs u;
 161 } __packed;
 162
 163 /*
 164  * Note that UD packets with a GRH header are 8+40+12+8 = 68 bytes
 165  * long (72 w/ imm_data).  Only the first 56 bytes of the IB header
 166  * will be in the eager header buffer.  The remaining 12 or 16 bytes
 167  * are in the data buffer.
 168  */
 169 struct hfi1_ib_header {
 170         __be16 lrh[4];
 171         union {
 172                 struct {
 173                         struct ib_grh grh;
 174                         struct hfi1_other_headers oth;
 175                 } l;
 176                 struct hfi1_other_headers oth;
 177         } u;
 178 } __packed;
 179
 180 struct ahg_ib_header {
 181         struct sdma_engine *sde;
 182         u32 ahgdesc[2];
 183         u16 tx_flags;
 184         u8 ahgcount;
 185         u8 ahgidx;
 186         struct hfi1_ib_header ibh;
 187 };
 188
 189 struct hfi1_pio_header {
 190         __le64 pbc;
 191         struct hfi1_ib_header hdr;
 192 } __packed;
 193
 194 /*
 195  * hfi1 specific data structures that will be hidden from rvt after the queue
 196  * pair is made common
 197  */
 198 struct hfi1_qp_priv {
 199         struct ahg_ib_header *s_hdr;              /* next header to send */
 200         struct sdma_engine *s_sde;                /* current sde */
 201         struct send_context *s_sendcontext;       /* current sendcontext */
 202         u8 s_sc;                                  /* SC[0..4] for next packet */
 203         u8 r_adefered;                            /* number of acks defered */
 204         struct iowait s_iowait;
 205         struct timer_list s_rnr_timer;
 206         struct rvt_qp *owner;
 207 };
 208
 209 /*
 210  * This structure is used to hold commonly lookedup and computed values during
 211  * the send engine progress.
 212  */
 213 struct hfi1_pkt_state {
 214         struct hfi1_ibdev *dev;
 215         struct hfi1_ibport *ibp;
 216         struct hfi1_pportdata *ppd;
 217         struct verbs_txreq *s_txreq;
 218         unsigned long flags;
 219 };
 220
 221 #define HFI1_PSN_CREDIT  16
 222
 223 struct hfi1_opcode_stats {
 224         u64 n_packets;          /* number of packets */
 225         u64 n_bytes;            /* total number of bytes */
 226 };
 227
 228 struct hfi1_opcode_stats_perctx {
 229         struct hfi1_opcode_stats stats[256];
 230 };
 231
 232 static inline void inc_opstats(
 233         u32 tlen,
 234         struct hfi1_opcode_stats *stats)
 235 {
 236 #ifdef CONFIG_DEBUG_FS
 237         stats->n_bytes += tlen;
 238         stats->n_packets++;
 239 #endif
 240 }
 241
 242 struct hfi1_ibport {
 243         struct rvt_qp __rcu *qp[2];
 244         struct rvt_ibport rvp;
 245
 246         __be64 guids[HFI1_GUIDS_PER_PORT        - 1];   /* writable GUIDs */
 247
 248         /* the first 16 entries are sl_to_vl for !OPA */
 249         u8 sl_to_sc[32];
 250         u8 sc_to_sl[32];
 251 };
 252
 253 struct hfi1_ibdev {
 254         struct rvt_dev_info rdi; /* Must be first */
 255
 256         /* QP numbers are shared by all IB ports */
 257         /* protect wait lists */
 258         seqlock_t iowait_lock;
 259         struct list_head txwait;        /* list for wait verbs_txreq */
 260         struct list_head memwait;       /* list for wait kernel memory */
 261         struct list_head txreq_free;
 262         struct kmem_cache *verbs_txreq_cache;
 263         struct timer_list mem_timer;
 264
 265         u64 n_piowait;
 266         u64 n_piodrain;
 267         u64 n_txwait;
 268         u64 n_kmem_wait;
 269
 270 #ifdef CONFIG_DEBUG_FS
 271         /* per HFI debugfs */
 272         struct dentry *hfi1_ibdev_dbg;
 273         /* per HFI symlinks to above */
 274         struct dentry *hfi1_ibdev_link;
 275 #endif
 276 };
 277
 278 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
 279 {
 280         struct rvt_dev_info *rdi;
 281
 282         rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
 283         return container_of(rdi, struct hfi1_ibdev, rdi);
 284 }
 285
 286 static inline struct rvt_qp *iowait_to_qp(struct  iowait *s_iowait)
 287 {
 288         struct hfi1_qp_priv *priv;
 289
 290         priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
 291         return priv->owner;
 292 }
 293
 294 /*
 295  * Send if not busy or waiting for I/O and either
 296  * a RC response is pending or we can process send work requests.
 297  */
 298 static inline int hfi1_send_ok(struct rvt_qp *qp)
 299 {
 300         return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
 301                 (qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
 302                  !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
 303 }
 304
 305 /*
 306  * This must be called with s_lock held.
 307  */
 308 void hfi1_bad_pqkey(struct hfi1_ibport *ibp, __be16 trap_num, u32 key, u32 sl,
 309                     u32 qp1, u32 qp2, u16 lid1, u16 lid2);
 310 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
 311 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
 312 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
 313 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
 314                      const struct ib_wc *in_wc, const struct ib_grh *in_grh,
 315                      const struct ib_mad_hdr *in_mad, size_t in_mad_size,
 316                      struct ib_mad_hdr *out_mad, size_t *out_mad_size,
 317                      u16 *out_mad_pkey_index);
 318
 319 /*
 320  * The PSN_MASK and PSN_SHIFT allow for
 321  * 1) comparing two PSNs
 322  * 2) returning the PSN with any upper bits masked
 323  * 3) returning the difference between to PSNs
 324  *
 325  * The number of significant bits in the PSN must
 326  * necessarily be at least one bit less than
 327  * the container holding the PSN.
 328  */
 329 #ifndef CONFIG_HFI1_VERBS_31BIT_PSN
 330 #define PSN_MASK 0xFFFFFF
 331 #define PSN_SHIFT 8
 332 #else
 333 #define PSN_MASK 0x7FFFFFFF
 334 #define PSN_SHIFT 1
 335 #endif
 336 #define PSN_MODIFY_MASK 0xFFFFFF
 337
 338 /* Number of bits to pay attention to in the opcode for checking qp type */
 339 #define OPCODE_QP_MASK 0xE0
 340
 341 /*
 342  * Compare the lower 24 bits of the msn values.
 343  * Returns an integer <, ==, or > than zero.
 344  */
 345 static inline int cmp_msn(u32 a, u32 b)
 346 {
 347         return (((int)a) - ((int)b)) << 8;
 348 }
 349
 350 /*
 351  * Compare two PSNs
 352  * Returns an integer <, ==, or > than zero.
 353  */
 354 static inline int cmp_psn(u32 a, u32 b)
 355 {
 356         return (((int)a) - ((int)b)) << PSN_SHIFT;
 357 }
 358
 359 /*
 360  * Return masked PSN
 361  */
 362 static inline u32 mask_psn(u32 a)
 363 {
 364         return a & PSN_MASK;
 365 }
 366
 367 /*
 368  * Return delta between two PSNs
 369  */
 370 static inline u32 delta_psn(u32 a, u32 b)
 371 {
 372         return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
 373 }
 374
 375 struct verbs_txreq;
 376 void hfi1_put_txreq(struct verbs_txreq *tx);
 377
 378 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 379
 380 void hfi1_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
 381                    int release, int copy_last);
 382
 383 void hfi1_skip_sge(struct rvt_sge_state *ss, u32 length, int release);
 384
 385 void hfi1_cnp_rcv(struct hfi1_packet *packet);
 386
 387 void hfi1_uc_rcv(struct hfi1_packet *packet);
 388
 389 void hfi1_rc_rcv(struct hfi1_packet *packet);
 390
 391 void hfi1_rc_hdrerr(
 392         struct hfi1_ctxtdata *rcd,
 393         struct hfi1_ib_header *hdr,
 394         u32 rcv_flags,
 395         struct rvt_qp *qp);
 396
 397 u8 ah_to_sc(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
 398
 399 struct ib_ah *hfi1_create_qp0_ah(struct hfi1_ibport *ibp, u16 dlid);
 400
 401 void hfi1_rc_rnr_retry(unsigned long arg);
 402 void hfi1_add_rnr_timer(struct rvt_qp *qp, u32 to);
 403 void hfi1_rc_timeout(unsigned long arg);
 404 void hfi1_del_timers_sync(struct rvt_qp *qp);
 405 void hfi1_stop_rc_timers(struct rvt_qp *qp);
 406
 407 void hfi1_rc_send_complete(struct rvt_qp *qp, struct hfi1_ib_header *hdr);
 408
 409 void hfi1_rc_error(struct rvt_qp *qp, enum ib_wc_status err);
 410
 411 void hfi1_ud_rcv(struct hfi1_packet *packet);
 412
 413 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
 414
 415 int hfi1_rvt_get_rwqe(struct rvt_qp *qp, int wr_id_only);
 416
 417 void hfi1_migrate_qp(struct rvt_qp *qp);
 418
 419 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 420                          int attr_mask, struct ib_udata *udata);
 421
 422 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 423                     int attr_mask, struct ib_udata *udata);
 424
 425 int hfi1_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
 426
 427 extern const u32 rc_only_opcode;
 428 extern const u32 uc_only_opcode;
 429
 430 static inline u8 get_opcode(struct hfi1_ib_header *h)
 431 {
 432         u16 lnh = be16_to_cpu(h->lrh[0]) & 3;
 433
 434         if (lnh == IB_LNH_IBA_LOCAL)
 435                 return be32_to_cpu(h->u.oth.bth[0]) >> 24;
 436         else
 437                 return be32_to_cpu(h->u.l.oth.bth[0]) >> 24;
 438 }
 439
 440 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_ib_header *hdr,
 441                        int has_grh, struct rvt_qp *qp, u32 bth0);
 442
 443 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
 444                   struct ib_global_route *grh, u32 hwords, u32 nwords);
 445
 446 void hfi1_make_ruc_header(struct rvt_qp *qp, struct hfi1_other_headers *ohdr,
 447                           u32 bth0, u32 bth2, int middle,
 448                           struct hfi1_pkt_state *ps);
 449
 450 void _hfi1_do_send(struct work_struct *work);
 451
 452 void hfi1_do_send(struct rvt_qp *qp);
 453
 454 void hfi1_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
 455                         enum ib_wc_status status);
 456
 457 void hfi1_send_rc_ack(struct hfi1_ctxtdata *, struct rvt_qp *qp, int is_fecn);
 458
 459 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 460
 461 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 462
 463 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 464
 465 int hfi1_register_ib_device(struct hfi1_devdata *);
 466
 467 void hfi1_unregister_ib_device(struct hfi1_devdata *);
 468
 469 void hfi1_ib_rcv(struct hfi1_packet *packet);
 470
 471 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
 472
 473 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 474                         u64 pbc);
 475
 476 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 477                         u64 pbc);
 478
 479 int hfi1_wss_init(void);
 480 void hfi1_wss_exit(void);
 481
 482 /* platform specific: return the lowest level cache (llc) size, in KiB */
 483 static inline int wss_llc_size(void)
 484 {
 485         /* assume that the boot CPU value is universal for all CPUs */
 486         return boot_cpu_data.x86_cache_size;
 487 }
 488
 489 /* platform specific: cacheless copy */
 490 static inline void cacheless_memcpy(void *dst, void *src, size_t n)
 491 {
 492         /*
 493          * Use the only available X64 cacheless copy.  Add a __user cast
 494          * to quiet sparse.  The src agument is already in the kernel so
 495          * there are no security issues.  The extra fault recovery machinery
 496          * is not invoked.
 497          */
 498         __copy_user_nocache(dst, (void __user *)src, n, 0);
 499 }
 500
 501 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
 502
 503 extern const u8 hdr_len_by_opcode[];
 504
 505 extern const int ib_rvt_state_ops[];
 506
 507 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
 508
 509 extern unsigned int hfi1_max_cqes;
 510
 511 extern unsigned int hfi1_max_cqs;
 512
 513 extern unsigned int hfi1_max_qp_wrs;
 514
 515 extern unsigned int hfi1_max_qps;
 516
 517 extern unsigned int hfi1_max_sges;
 518
 519 extern unsigned int hfi1_max_mcast_grps;
 520
 521 extern unsigned int hfi1_max_mcast_qp_attached;
 522
 523 extern unsigned int hfi1_max_srqs;
 524
 525 extern unsigned int hfi1_max_srq_sges;
 526
 527 extern unsigned int hfi1_max_srq_wrs;
 528
 529 extern unsigned short piothreshold;
 530
 531 extern const u32 ib_hfi1_rnr_table[];
 532
 533 #endif                          /* HFI1_VERBS_H */