drivers/staging/rdma/hfi1/verbs.h

   1 /*
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2015 Intel Corporation.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * BSD LICENSE
  20  *
  21  * Copyright(c) 2015 Intel Corporation.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  *
  27  *  - Redistributions of source code must retain the above copyright
  28  *    notice, this list of conditions and the following disclaimer.
  29  *  - Redistributions in binary form must reproduce the above copyright
  30  *    notice, this list of conditions and the following disclaimer in
  31  *    the documentation and/or other materials provided with the
  32  *    distribution.
  33  *  - Neither the name of Intel Corporation nor the names of its
  34  *    contributors may be used to endorse or promote products derived
  35  *    from this software without specific prior written permission.
  36  *
  37  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  38  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  39  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  40  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  41  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  44  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  45  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  *
  49  */
  50
  51 #ifndef HFI1_VERBS_H
  52 #define HFI1_VERBS_H
  53
  54 #include <linux/types.h>
  55 #include <linux/seqlock.h>
  56 #include <linux/kernel.h>
  57 #include <linux/interrupt.h>
  58 #include <linux/kref.h>
  59 #include <linux/workqueue.h>
  60 #include <linux/kthread.h>
  61 #include <linux/completion.h>
  62 #include <rdma/ib_pack.h>
  63 #include <rdma/ib_user_verbs.h>
  64 #include <rdma/ib_mad.h>
  65 #include <rdma/rdma_vt.h>
  66 #include <rdma/rdmavt_qp.h>
  67 #include <rdma/rdmavt_cq.h>
  68
  69 struct hfi1_ctxtdata;
  70 struct hfi1_pportdata;
  71 struct hfi1_devdata;
  72 struct hfi1_packet;
  73
  74 #include "iowait.h"
  75
  76 #define HFI1_MAX_RDMA_ATOMIC     16
  77 #define HFI1_GUIDS_PER_PORT     5
  78
  79 /*
  80  * Increment this value if any changes that break userspace ABI
  81  * compatibility are made.
  82  */
  83 #define HFI1_UVERBS_ABI_VERSION       2
  84
  85 #define IB_SEQ_NAK      (3 << 29)
  86
  87 /* AETH NAK opcode values */
  88 #define IB_RNR_NAK                      0x20
  89 #define IB_NAK_PSN_ERROR                0x60
  90 #define IB_NAK_INVALID_REQUEST          0x61
  91 #define IB_NAK_REMOTE_ACCESS_ERROR      0x62
  92 #define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
  93 #define IB_NAK_INVALID_RD_REQUEST       0x64
  94
  95 /* IB Performance Manager status values */
  96 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
  97 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
  98 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
  99
 100 /* Mandatory IB performance counter select values. */
 101 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
 102 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
 103 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
 104 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
 105 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
 106
 107 #define HFI1_VENDOR_IPG         cpu_to_be16(0xFFA0)
 108
 109 #define IB_BTH_REQ_ACK          BIT(31)
 110 #define IB_BTH_SOLICITED        BIT(23)
 111 #define IB_BTH_MIG_REQ          BIT(22)
 112
 113 #define IB_GRH_VERSION          6
 114 #define IB_GRH_VERSION_MASK     0xF
 115 #define IB_GRH_VERSION_SHIFT    28
 116 #define IB_GRH_TCLASS_MASK      0xFF
 117 #define IB_GRH_TCLASS_SHIFT     20
 118 #define IB_GRH_FLOW_MASK        0xFFFFF
 119 #define IB_GRH_FLOW_SHIFT       0
 120 #define IB_GRH_NEXT_HDR         0x1B
 121
 122 #define IB_DEFAULT_GID_PREFIX   cpu_to_be64(0xfe80000000000000ULL)
 123
 124 /* flags passed by hfi1_ib_rcv() */
 125 enum {
 126         HFI1_HAS_GRH = (1 << 0),
 127 };
 128
 129 struct ib_reth {
 130         __be64 vaddr;
 131         __be32 rkey;
 132         __be32 length;
 133 } __packed;
 134
 135 struct ib_atomic_eth {
 136         __be32 vaddr[2];        /* unaligned so access as 2 32-bit words */
 137         __be32 rkey;
 138         __be64 swap_data;
 139         __be64 compare_data;
 140 } __packed;
 141
 142 union ib_ehdrs {
 143         struct {
 144                 __be32 deth[2];
 145                 __be32 imm_data;
 146         } ud;
 147         struct {
 148                 struct ib_reth reth;
 149                 __be32 imm_data;
 150         } rc;
 151         struct {
 152                 __be32 aeth;
 153                 __be32 atomic_ack_eth[2];
 154         } at;
 155         __be32 imm_data;
 156         __be32 aeth;
 157         struct ib_atomic_eth atomic_eth;
 158 }  __packed;
 159
 160 struct hfi1_other_headers {
 161         __be32 bth[3];
 162         union ib_ehdrs u;
 163 } __packed;
 164
 165 /*
 166  * Note that UD packets with a GRH header are 8+40+12+8 = 68 bytes
 167  * long (72 w/ imm_data).  Only the first 56 bytes of the IB header
 168  * will be in the eager header buffer.  The remaining 12 or 16 bytes
 169  * are in the data buffer.
 170  */
 171 struct hfi1_ib_header {
 172         __be16 lrh[4];
 173         union {
 174                 struct {
 175                         struct ib_grh grh;
 176                         struct hfi1_other_headers oth;
 177                 } l;
 178                 struct hfi1_other_headers oth;
 179         } u;
 180 } __packed;
 181
 182 struct ahg_ib_header {
 183         struct sdma_engine *sde;
 184         u32 ahgdesc[2];
 185         u16 tx_flags;
 186         u8 ahgcount;
 187         u8 ahgidx;
 188         struct hfi1_ib_header ibh;
 189 };
 190
 191 struct hfi1_pio_header {
 192         __le64 pbc;
 193         struct hfi1_ib_header hdr;
 194 } __packed;
 195
 196 /*
 197  * used for force cacheline alignment for AHG
 198  */
 199 struct tx_pio_header {
 200         struct hfi1_pio_header phdr;
 201 } ____cacheline_aligned;
 202
 203 /*
 204  * hfi1 specific data structures that will be hidden from rvt after the queue
 205  * pair is made common
 206  */
 207 struct hfi1_qp_priv {
 208         struct ahg_ib_header *s_hdr; /* next packet header to send */
 209         struct sdma_engine *s_sde;   /* current sde */
 210         u8 s_sc;                     /* SC[0..4] for next packet */
 211         u8 r_adefered;               /* number of acks defered */
 212         struct iowait s_iowait;
 213         struct rvt_qp *owner;
 214 };
 215
 216 /*
 217  * This structure is used to hold commonly lookedup and computed values during
 218  * the send engine progress.
 219  */
 220 struct hfi1_pkt_state {
 221         struct hfi1_ibdev *dev;
 222         struct hfi1_ibport *ibp;
 223         struct hfi1_pportdata *ppd;
 224 };
 225
 226 #define HFI1_PSN_CREDIT  16
 227
 228 struct hfi1_opcode_stats {
 229         u64 n_packets;          /* number of packets */
 230         u64 n_bytes;            /* total number of bytes */
 231 };
 232
 233 struct hfi1_opcode_stats_perctx {
 234         struct hfi1_opcode_stats stats[256];
 235 };
 236
 237 static inline void inc_opstats(
 238         u32 tlen,
 239         struct hfi1_opcode_stats *stats)
 240 {
 241 #ifdef CONFIG_DEBUG_FS
 242         stats->n_bytes += tlen;
 243         stats->n_packets++;
 244 #endif
 245 }
 246
 247 struct hfi1_ibport {
 248         struct rvt_qp __rcu *qp[2];
 249         struct rvt_ibport rvp;
 250
 251         __be64 guids[HFI1_GUIDS_PER_PORT        - 1];   /* writable GUIDs */
 252
 253         /* the first 16 entries are sl_to_vl for !OPA */
 254         u8 sl_to_sc[32];
 255         u8 sc_to_sl[32];
 256 };
 257
 258 struct hfi1_ibdev {
 259         struct rvt_dev_info rdi; /* Must be first */
 260
 261         /* QP numbers are shared by all IB ports */
 262         /* protect wait lists */
 263         seqlock_t iowait_lock;
 264         struct list_head txwait;        /* list for wait verbs_txreq */
 265         struct list_head memwait;       /* list for wait kernel memory */
 266         struct list_head txreq_free;
 267         struct kmem_cache *verbs_txreq_cache;
 268         struct timer_list mem_timer;
 269
 270         u64 n_piowait;
 271         u64 n_txwait;
 272         u64 n_kmem_wait;
 273
 274 #ifdef CONFIG_DEBUG_FS
 275         /* per HFI debugfs */
 276         struct dentry *hfi1_ibdev_dbg;
 277         /* per HFI symlinks to above */
 278         struct dentry *hfi1_ibdev_link;
 279 #endif
 280 };
 281
 282 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
 283 {
 284         struct rvt_dev_info *rdi;
 285
 286         rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
 287         return container_of(rdi, struct hfi1_ibdev, rdi);
 288 }
 289
 290 static inline struct rvt_qp *iowait_to_qp(struct  iowait *s_iowait)
 291 {
 292         struct hfi1_qp_priv *priv;
 293
 294         priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
 295         return priv->owner;
 296 }
 297
 298 /*
 299  * Send if not busy or waiting for I/O and either
 300  * a RC response is pending or we can process send work requests.
 301  */
 302 static inline int hfi1_send_ok(struct rvt_qp *qp)
 303 {
 304         return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
 305                 (qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
 306                  !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
 307 }
 308
 309 /*
 310  * This must be called with s_lock held.
 311  */
 312 void hfi1_bad_pqkey(struct hfi1_ibport *ibp, __be16 trap_num, u32 key, u32 sl,
 313                     u32 qp1, u32 qp2, u16 lid1, u16 lid2);
 314 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
 315 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
 316 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
 317 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
 318                      const struct ib_wc *in_wc, const struct ib_grh *in_grh,
 319                      const struct ib_mad_hdr *in_mad, size_t in_mad_size,
 320                      struct ib_mad_hdr *out_mad, size_t *out_mad_size,
 321                      u16 *out_mad_pkey_index);
 322
 323 /*
 324  * The PSN_MASK and PSN_SHIFT allow for
 325  * 1) comparing two PSNs
 326  * 2) returning the PSN with any upper bits masked
 327  * 3) returning the difference between to PSNs
 328  *
 329  * The number of significant bits in the PSN must
 330  * necessarily be at least one bit less than
 331  * the container holding the PSN.
 332  */
 333 #ifndef CONFIG_HFI1_VERBS_31BIT_PSN
 334 #define PSN_MASK 0xFFFFFF
 335 #define PSN_SHIFT 8
 336 #else
 337 #define PSN_MASK 0x7FFFFFFF
 338 #define PSN_SHIFT 1
 339 #endif
 340 #define PSN_MODIFY_MASK 0xFFFFFF
 341
 342 /* Number of bits to pay attention to in the opcode for checking qp type */
 343 #define OPCODE_QP_MASK 0xE0
 344
 345 /*
 346  * Compare the lower 24 bits of the msn values.
 347  * Returns an integer <, ==, or > than zero.
 348  */
 349 static inline int cmp_msn(u32 a, u32 b)
 350 {
 351         return (((int) a) - ((int) b)) << 8;
 352 }
 353
 354 /*
 355  * Compare two PSNs
 356  * Returns an integer <, ==, or > than zero.
 357  */
 358 static inline int cmp_psn(u32 a, u32 b)
 359 {
 360         return (((int) a) - ((int) b)) << PSN_SHIFT;
 361 }
 362
 363 /*
 364  * Return masked PSN
 365  */
 366 static inline u32 mask_psn(u32 a)
 367 {
 368         return a & PSN_MASK;
 369 }
 370
 371 /*
 372  * Return delta between two PSNs
 373  */
 374 static inline u32 delta_psn(u32 a, u32 b)
 375 {
 376         return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
 377 }
 378
 379 struct verbs_txreq;
 380 void hfi1_put_txreq(struct verbs_txreq *tx);
 381
 382 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 383
 384 void hfi1_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
 385                    int release, int copy_last);
 386
 387 void hfi1_skip_sge(struct rvt_sge_state *ss, u32 length, int release);
 388
 389 void hfi1_cnp_rcv(struct hfi1_packet *packet);
 390
 391 void hfi1_uc_rcv(struct hfi1_packet *packet);
 392
 393 void hfi1_rc_rcv(struct hfi1_packet *packet);
 394
 395 void hfi1_rc_hdrerr(
 396         struct hfi1_ctxtdata *rcd,
 397         struct hfi1_ib_header *hdr,
 398         u32 rcv_flags,
 399         struct rvt_qp *qp);
 400
 401 u8 ah_to_sc(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
 402
 403 struct ib_ah *hfi1_create_qp0_ah(struct hfi1_ibport *ibp, u16 dlid);
 404
 405 void hfi1_rc_rnr_retry(unsigned long arg);
 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_wr(struct rvt_qp *qp, struct ib_send_wr *wr);
 426
 427 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_ib_header *hdr,
 428                        int has_grh, struct rvt_qp *qp, u32 bth0);
 429
 430 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
 431                   struct ib_global_route *grh, u32 hwords, u32 nwords);
 432
 433 void hfi1_make_ruc_header(struct rvt_qp *qp, struct hfi1_other_headers *ohdr,
 434                           u32 bth0, u32 bth2, int middle);
 435
 436 void _hfi1_do_send(struct work_struct *work);
 437
 438 void hfi1_do_send(struct rvt_qp *qp);
 439
 440 void hfi1_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
 441                         enum ib_wc_status status);
 442
 443 void hfi1_send_rc_ack(struct hfi1_ctxtdata *, struct rvt_qp *qp, int is_fecn);
 444
 445 int hfi1_make_rc_req(struct rvt_qp *qp);
 446
 447 int hfi1_make_uc_req(struct rvt_qp *qp);
 448
 449 int hfi1_make_ud_req(struct rvt_qp *qp);
 450
 451 int hfi1_register_ib_device(struct hfi1_devdata *);
 452
 453 void hfi1_unregister_ib_device(struct hfi1_devdata *);
 454
 455 void hfi1_ib_rcv(struct hfi1_packet *packet);
 456
 457 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
 458
 459 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 460                         u64 pbc);
 461
 462 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 463                         u64 pbc);
 464
 465 struct send_context *qp_to_send_context(struct rvt_qp *qp, u8 sc5);
 466
 467 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
 468
 469 extern const u8 hdr_len_by_opcode[];
 470
 471 extern const int ib_rvt_state_ops[];
 472
 473 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
 474
 475 extern unsigned int hfi1_max_cqes;
 476
 477 extern unsigned int hfi1_max_cqs;
 478
 479 extern unsigned int hfi1_max_qp_wrs;
 480
 481 extern unsigned int hfi1_max_qps;
 482
 483 extern unsigned int hfi1_max_sges;
 484
 485 extern unsigned int hfi1_max_mcast_grps;
 486
 487 extern unsigned int hfi1_max_mcast_qp_attached;
 488
 489 extern unsigned int hfi1_max_srqs;
 490
 491 extern unsigned int hfi1_max_srq_sges;
 492
 493 extern unsigned int hfi1_max_srq_wrs;
 494
 495 extern const u32 ib_hfi1_rnr_table[];
 496
 497 #endif                          /* HFI1_VERBS_H */