include/rdma/ib_verbs.h

   1 /*
   2  * Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
   3  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
   4  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
   5  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
   6  * Copyright (c) 2004 Voltaire Corporation.  All rights reserved.
   7  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   8  * Copyright (c) 2005, 2006, 2007 Cisco Systems.  All rights reserved.
   9  *
  10  * This software is available to you under a choice of one of two
  11  * licenses.  You may choose to be licensed under the terms of the GNU
  12  * General Public License (GPL) Version 2, available from the file
  13  * COPYING in the main directory of this source tree, or the
  14  * OpenIB.org BSD license below:
  15  *
  16  *     Redistribution and use in source and binary forms, with or
  17  *     without modification, are permitted provided that the following
  18  *     conditions are met:
  19  *
  20  *      - Redistributions of source code must retain the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer.
  23  *
  24  *      - Redistributions in binary form must reproduce the above
  25  *        copyright notice, this list of conditions and the following
  26  *        disclaimer in the documentation and/or other materials
  27  *        provided with the distribution.
  28  *
  29  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  33  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  34  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  35  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  36  * SOFTWARE.
  37  */
  38
  39 #if !defined(IB_VERBS_H)
  40 #define IB_VERBS_H
  41
  42 #include <linux/types.h>
  43 #include <linux/device.h>
  44 #include <linux/mm.h>
  45 #include <linux/dma-mapping.h>
  46 #include <linux/kref.h>
  47 #include <linux/list.h>
  48 #include <linux/rwsem.h>
  49 #include <linux/scatterlist.h>
  50 #include <linux/workqueue.h>
  51 #include <linux/socket.h>
  52 #include <linux/irq_poll.h>
  53 #include <uapi/linux/if_ether.h>
  54 #include <net/ipv6.h>
  55 #include <net/ip.h>
  56 #include <linux/string.h>
  57 #include <linux/slab.h>
  58
  59 #include <linux/if_link.h>
  60 #include <linux/atomic.h>
  61 #include <linux/mmu_notifier.h>
  62 #include <linux/uaccess.h>
  63 #include <linux/cgroup_rdma.h>
  64
  65 extern struct workqueue_struct *ib_wq;
  66 extern struct workqueue_struct *ib_comp_wq;
  67
  68 union ib_gid {
  69         u8      raw[16];
  70         struct {
  71                 __be64  subnet_prefix;
  72                 __be64  interface_id;
  73         } global;
  74 };
  75
  76 extern union ib_gid zgid;
  77
  78 enum ib_gid_type {
  79         /* If link layer is Ethernet, this is RoCE V1 */
  80         IB_GID_TYPE_IB        = 0,
  81         IB_GID_TYPE_ROCE      = 0,
  82         IB_GID_TYPE_ROCE_UDP_ENCAP = 1,
  83         IB_GID_TYPE_SIZE
  84 };
  85
  86 #define ROCE_V2_UDP_DPORT      4791
  87 struct ib_gid_attr {
  88         enum ib_gid_type        gid_type;
  89         struct net_device       *ndev;
  90 };
  91
  92 enum rdma_node_type {
  93         /* IB values map to NodeInfo:NodeType. */
  94         RDMA_NODE_IB_CA         = 1,
  95         RDMA_NODE_IB_SWITCH,
  96         RDMA_NODE_IB_ROUTER,
  97         RDMA_NODE_RNIC,
  98         RDMA_NODE_USNIC,
  99         RDMA_NODE_USNIC_UDP,
 100 };
 101
 102 enum {
 103         /* set the local administered indication */
 104         IB_SA_WELL_KNOWN_GUID   = BIT_ULL(57) | 2,
 105 };
 106
 107 enum rdma_transport_type {
 108         RDMA_TRANSPORT_IB,
 109         RDMA_TRANSPORT_IWARP,
 110         RDMA_TRANSPORT_USNIC,
 111         RDMA_TRANSPORT_USNIC_UDP
 112 };
 113
 114 enum rdma_protocol_type {
 115         RDMA_PROTOCOL_IB,
 116         RDMA_PROTOCOL_IBOE,
 117         RDMA_PROTOCOL_IWARP,
 118         RDMA_PROTOCOL_USNIC_UDP
 119 };
 120
 121 __attribute_const__ enum rdma_transport_type
 122 rdma_node_get_transport(enum rdma_node_type node_type);
 123
 124 enum rdma_network_type {
 125         RDMA_NETWORK_IB,
 126         RDMA_NETWORK_ROCE_V1 = RDMA_NETWORK_IB,
 127         RDMA_NETWORK_IPV4,
 128         RDMA_NETWORK_IPV6
 129 };
 130
 131 static inline enum ib_gid_type ib_network_to_gid_type(enum rdma_network_type network_type)
 132 {
 133         if (network_type == RDMA_NETWORK_IPV4 ||
 134             network_type == RDMA_NETWORK_IPV6)
 135                 return IB_GID_TYPE_ROCE_UDP_ENCAP;
 136
 137         /* IB_GID_TYPE_IB same as RDMA_NETWORK_ROCE_V1 */
 138         return IB_GID_TYPE_IB;
 139 }
 140
 141 static inline enum rdma_network_type ib_gid_to_network_type(enum ib_gid_type gid_type,
 142                                                             union ib_gid *gid)
 143 {
 144         if (gid_type == IB_GID_TYPE_IB)
 145                 return RDMA_NETWORK_IB;
 146
 147         if (ipv6_addr_v4mapped((struct in6_addr *)gid))
 148                 return RDMA_NETWORK_IPV4;
 149         else
 150                 return RDMA_NETWORK_IPV6;
 151 }
 152
 153 enum rdma_link_layer {
 154         IB_LINK_LAYER_UNSPECIFIED,
 155         IB_LINK_LAYER_INFINIBAND,
 156         IB_LINK_LAYER_ETHERNET,
 157 };
 158
 159 enum ib_device_cap_flags {
 160         IB_DEVICE_RESIZE_MAX_WR                 = (1 << 0),
 161         IB_DEVICE_BAD_PKEY_CNTR                 = (1 << 1),
 162         IB_DEVICE_BAD_QKEY_CNTR                 = (1 << 2),
 163         IB_DEVICE_RAW_MULTI                     = (1 << 3),
 164         IB_DEVICE_AUTO_PATH_MIG                 = (1 << 4),
 165         IB_DEVICE_CHANGE_PHY_PORT               = (1 << 5),
 166         IB_DEVICE_UD_AV_PORT_ENFORCE            = (1 << 6),
 167         IB_DEVICE_CURR_QP_STATE_MOD             = (1 << 7),
 168         IB_DEVICE_SHUTDOWN_PORT                 = (1 << 8),
 169         IB_DEVICE_INIT_TYPE                     = (1 << 9),
 170         IB_DEVICE_PORT_ACTIVE_EVENT             = (1 << 10),
 171         IB_DEVICE_SYS_IMAGE_GUID                = (1 << 11),
 172         IB_DEVICE_RC_RNR_NAK_GEN                = (1 << 12),
 173         IB_DEVICE_SRQ_RESIZE                    = (1 << 13),
 174         IB_DEVICE_N_NOTIFY_CQ                   = (1 << 14),
 175
 176         /*
 177          * This device supports a per-device lkey or stag that can be
 178          * used without performing a memory registration for the local
 179          * memory.  Note that ULPs should never check this flag, but
 180          * instead of use the local_dma_lkey flag in the ib_pd structure,
 181          * which will always contain a usable lkey.
 182          */
 183         IB_DEVICE_LOCAL_DMA_LKEY                = (1 << 15),
 184         IB_DEVICE_RESERVED /* old SEND_W_INV */ = (1 << 16),
 185         IB_DEVICE_MEM_WINDOW                    = (1 << 17),
 186         /*
 187          * Devices should set IB_DEVICE_UD_IP_SUM if they support
 188          * insertion of UDP and TCP checksum on outgoing UD IPoIB
 189          * messages and can verify the validity of checksum for
 190          * incoming messages.  Setting this flag implies that the
 191          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
 192          */
 193         IB_DEVICE_UD_IP_CSUM                    = (1 << 18),
 194         IB_DEVICE_UD_TSO                        = (1 << 19),
 195         IB_DEVICE_XRC                           = (1 << 20),
 196
 197         /*
 198          * This device supports the IB "base memory management extension",
 199          * which includes support for fast registrations (IB_WR_REG_MR,
 200          * IB_WR_LOCAL_INV and IB_WR_SEND_WITH_INV verbs).  This flag should
 201          * also be set by any iWarp device which must support FRs to comply
 202          * to the iWarp verbs spec.  iWarp devices also support the
 203          * IB_WR_RDMA_READ_WITH_INV verb for RDMA READs that invalidate the
 204          * stag.
 205          */
 206         IB_DEVICE_MEM_MGT_EXTENSIONS            = (1 << 21),
 207         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK      = (1 << 22),
 208         IB_DEVICE_MEM_WINDOW_TYPE_2A            = (1 << 23),
 209         IB_DEVICE_MEM_WINDOW_TYPE_2B            = (1 << 24),
 210         IB_DEVICE_RC_IP_CSUM                    = (1 << 25),
 211         /* Deprecated. Please use IB_RAW_PACKET_CAP_IP_CSUM. */
 212         IB_DEVICE_RAW_IP_CSUM                   = (1 << 26),
 213         /*
 214          * Devices should set IB_DEVICE_CROSS_CHANNEL if they
 215          * support execution of WQEs that involve synchronization
 216          * of I/O operations with single completion queue managed
 217          * by hardware.
 218          */
 219         IB_DEVICE_CROSS_CHANNEL         = (1 << 27),
 220         IB_DEVICE_MANAGED_FLOW_STEERING         = (1 << 29),
 221         IB_DEVICE_SIGNATURE_HANDOVER            = (1 << 30),
 222         IB_DEVICE_ON_DEMAND_PAGING              = (1ULL << 31),
 223         IB_DEVICE_SG_GAPS_REG                   = (1ULL << 32),
 224         IB_DEVICE_VIRTUAL_FUNCTION              = (1ULL << 33),
 225         /* Deprecated. Please use IB_RAW_PACKET_CAP_SCATTER_FCS. */
 226         IB_DEVICE_RAW_SCATTER_FCS               = (1ULL << 34),
 227 };
 228
 229 enum ib_signature_prot_cap {
 230         IB_PROT_T10DIF_TYPE_1 = 1,
 231         IB_PROT_T10DIF_TYPE_2 = 1 << 1,
 232         IB_PROT_T10DIF_TYPE_3 = 1 << 2,
 233 };
 234
 235 enum ib_signature_guard_cap {
 236         IB_GUARD_T10DIF_CRC     = 1,
 237         IB_GUARD_T10DIF_CSUM    = 1 << 1,
 238 };
 239
 240 enum ib_atomic_cap {
 241         IB_ATOMIC_NONE,
 242         IB_ATOMIC_HCA,
 243         IB_ATOMIC_GLOB
 244 };
 245
 246 enum ib_odp_general_cap_bits {
 247         IB_ODP_SUPPORT          = 1 << 0,
 248         IB_ODP_SUPPORT_IMPLICIT = 1 << 1,
 249 };
 250
 251 enum ib_odp_transport_cap_bits {
 252         IB_ODP_SUPPORT_SEND     = 1 << 0,
 253         IB_ODP_SUPPORT_RECV     = 1 << 1,
 254         IB_ODP_SUPPORT_WRITE    = 1 << 2,
 255         IB_ODP_SUPPORT_READ     = 1 << 3,
 256         IB_ODP_SUPPORT_ATOMIC   = 1 << 4,
 257 };
 258
 259 struct ib_odp_caps {
 260         uint64_t general_caps;
 261         struct {
 262                 uint32_t  rc_odp_caps;
 263                 uint32_t  uc_odp_caps;
 264                 uint32_t  ud_odp_caps;
 265         } per_transport_caps;
 266 };
 267
 268 struct ib_rss_caps {
 269         /* Corresponding bit will be set if qp type from
 270          * 'enum ib_qp_type' is supported, e.g.
 271          * supported_qpts |= 1 << IB_QPT_UD
 272          */
 273         u32 supported_qpts;
 274         u32 max_rwq_indirection_tables;
 275         u32 max_rwq_indirection_table_size;
 276 };
 277
 278 enum ib_cq_creation_flags {
 279         IB_CQ_FLAGS_TIMESTAMP_COMPLETION   = 1 << 0,
 280         IB_CQ_FLAGS_IGNORE_OVERRUN         = 1 << 1,
 281 };
 282
 283 struct ib_cq_init_attr {
 284         unsigned int    cqe;
 285         int             comp_vector;
 286         u32             flags;
 287 };
 288
 289 struct ib_device_attr {
 290         u64                     fw_ver;
 291         __be64                  sys_image_guid;
 292         u64                     max_mr_size;
 293         u64                     page_size_cap;
 294         u32                     vendor_id;
 295         u32                     vendor_part_id;
 296         u32                     hw_ver;
 297         int                     max_qp;
 298         int                     max_qp_wr;
 299         u64                     device_cap_flags;
 300         int                     max_sge;
 301         int                     max_sge_rd;
 302         int                     max_cq;
 303         int                     max_cqe;
 304         int                     max_mr;
 305         int                     max_pd;
 306         int                     max_qp_rd_atom;
 307         int                     max_ee_rd_atom;
 308         int                     max_res_rd_atom;
 309         int                     max_qp_init_rd_atom;
 310         int                     max_ee_init_rd_atom;
 311         enum ib_atomic_cap      atomic_cap;
 312         enum ib_atomic_cap      masked_atomic_cap;
 313         int                     max_ee;
 314         int                     max_rdd;
 315         int                     max_mw;
 316         int                     max_raw_ipv6_qp;
 317         int                     max_raw_ethy_qp;
 318         int                     max_mcast_grp;
 319         int                     max_mcast_qp_attach;
 320         int                     max_total_mcast_qp_attach;
 321         int                     max_ah;
 322         int                     max_fmr;
 323         int                     max_map_per_fmr;
 324         int                     max_srq;
 325         int                     max_srq_wr;
 326         int                     max_srq_sge;
 327         unsigned int            max_fast_reg_page_list_len;
 328         u16                     max_pkeys;
 329         u8                      local_ca_ack_delay;
 330         int                     sig_prot_cap;
 331         int                     sig_guard_cap;
 332         struct ib_odp_caps      odp_caps;
 333         uint64_t                timestamp_mask;
 334         uint64_t                hca_core_clock; /* in KHZ */
 335         struct ib_rss_caps      rss_caps;
 336         u32                     max_wq_type_rq;
 337         u32                     raw_packet_caps; /* Use ib_raw_packet_caps enum */
 338 };
 339
 340 enum ib_mtu {
 341         IB_MTU_256  = 1,
 342         IB_MTU_512  = 2,
 343         IB_MTU_1024 = 3,
 344         IB_MTU_2048 = 4,
 345         IB_MTU_4096 = 5
 346 };
 347
 348 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 349 {
 350         switch (mtu) {
 351         case IB_MTU_256:  return  256;
 352         case IB_MTU_512:  return  512;
 353         case IB_MTU_1024: return 1024;
 354         case IB_MTU_2048: return 2048;
 355         case IB_MTU_4096: return 4096;
 356         default:          return -1;
 357         }
 358 }
 359
 360 static inline enum ib_mtu ib_mtu_int_to_enum(int mtu)
 361 {
 362         if (mtu >= 4096)
 363                 return IB_MTU_4096;
 364         else if (mtu >= 2048)
 365                 return IB_MTU_2048;
 366         else if (mtu >= 1024)
 367                 return IB_MTU_1024;
 368         else if (mtu >= 512)
 369                 return IB_MTU_512;
 370         else
 371                 return IB_MTU_256;
 372 }
 373
 374 enum ib_port_state {
 375         IB_PORT_NOP             = 0,
 376         IB_PORT_DOWN            = 1,
 377         IB_PORT_INIT            = 2,
 378         IB_PORT_ARMED           = 3,
 379         IB_PORT_ACTIVE          = 4,
 380         IB_PORT_ACTIVE_DEFER    = 5
 381 };
 382
 383 enum ib_port_cap_flags {
 384         IB_PORT_SM                              = 1 <<  1,
 385         IB_PORT_NOTICE_SUP                      = 1 <<  2,
 386         IB_PORT_TRAP_SUP                        = 1 <<  3,
 387         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
 388         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
 389         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
 390         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
 391         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
 392         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
 393         IB_PORT_SM_DISABLED                     = 1 << 10,
 394         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
 395         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
 396         IB_PORT_EXTENDED_SPEEDS_SUP             = 1 << 14,
 397         IB_PORT_CM_SUP                          = 1 << 16,
 398         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
 399         IB_PORT_REINIT_SUP                      = 1 << 18,
 400         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
 401         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
 402         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
 403         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
 404         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
 405         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
 406         IB_PORT_CLIENT_REG_SUP                  = 1 << 25,
 407         IB_PORT_IP_BASED_GIDS                   = 1 << 26,
 408 };
 409
 410 enum ib_port_width {
 411         IB_WIDTH_1X     = 1,
 412         IB_WIDTH_4X     = 2,
 413         IB_WIDTH_8X     = 4,
 414         IB_WIDTH_12X    = 8
 415 };
 416
 417 static inline int ib_width_enum_to_int(enum ib_port_width width)
 418 {
 419         switch (width) {
 420         case IB_WIDTH_1X:  return  1;
 421         case IB_WIDTH_4X:  return  4;
 422         case IB_WIDTH_8X:  return  8;
 423         case IB_WIDTH_12X: return 12;
 424         default:          return -1;
 425         }
 426 }
 427
 428 enum ib_port_speed {
 429         IB_SPEED_SDR    = 1,
 430         IB_SPEED_DDR    = 2,
 431         IB_SPEED_QDR    = 4,
 432         IB_SPEED_FDR10  = 8,
 433         IB_SPEED_FDR    = 16,
 434         IB_SPEED_EDR    = 32
 435 };
 436
 437 /**
 438  * struct rdma_hw_stats
 439  * @timestamp - Used by the core code to track when the last update was
 440  * @lifespan - Used by the core code to determine how old the counters
 441  *   should be before being updated again.  Stored in jiffies, defaults
 442  *   to 10 milliseconds, drivers can override the default be specifying
 443  *   their own value during their allocation routine.
 444  * @name - Array of pointers to static names used for the counters in
 445  *   directory.
 446  * @num_counters - How many hardware counters there are.  If name is
 447  *   shorter than this number, a kernel oops will result.  Driver authors
 448  *   are encouraged to leave BUILD_BUG_ON(ARRAY_SIZE(@name) < num_counters)
 449  *   in their code to prevent this.
 450  * @value - Array of u64 counters that are accessed by the sysfs code and
 451  *   filled in by the drivers get_stats routine
 452  */
 453 struct rdma_hw_stats {
 454         unsigned long   timestamp;
 455         unsigned long   lifespan;
 456         const char * const *names;
 457         int             num_counters;
 458         u64             value[];
 459 };
 460
 461 #define RDMA_HW_STATS_DEFAULT_LIFESPAN 10
 462 /**
 463  * rdma_alloc_hw_stats_struct - Helper function to allocate dynamic struct
 464  *   for drivers.
 465  * @names - Array of static const char *
 466  * @num_counters - How many elements in array
 467  * @lifespan - How many milliseconds between updates
 468  */
 469 static inline struct rdma_hw_stats *rdma_alloc_hw_stats_struct(
 470                 const char * const *names, int num_counters,
 471                 unsigned long lifespan)
 472 {
 473         struct rdma_hw_stats *stats;
 474
 475         stats = kzalloc(sizeof(*stats) + num_counters * sizeof(u64),
 476                         GFP_KERNEL);
 477         if (!stats)
 478                 return NULL;
 479         stats->names = names;
 480         stats->num_counters = num_counters;
 481         stats->lifespan = msecs_to_jiffies(lifespan);
 482
 483         return stats;
 484 }
 485
 486
 487 /* Define bits for the various functionality this port needs to be supported by
 488  * the core.
 489  */
 490 /* Management                           0x00000FFF */
 491 #define RDMA_CORE_CAP_IB_MAD            0x00000001
 492 #define RDMA_CORE_CAP_IB_SMI            0x00000002
 493 #define RDMA_CORE_CAP_IB_CM             0x00000004
 494 #define RDMA_CORE_CAP_IW_CM             0x00000008
 495 #define RDMA_CORE_CAP_IB_SA             0x00000010
 496 #define RDMA_CORE_CAP_OPA_MAD           0x00000020
 497
 498 /* Address format                       0x000FF000 */
 499 #define RDMA_CORE_CAP_AF_IB             0x00001000
 500 #define RDMA_CORE_CAP_ETH_AH            0x00002000
 501
 502 /* Protocol                             0xFFF00000 */
 503 #define RDMA_CORE_CAP_PROT_IB           0x00100000
 504 #define RDMA_CORE_CAP_PROT_ROCE         0x00200000
 505 #define RDMA_CORE_CAP_PROT_IWARP        0x00400000
 506 #define RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP 0x00800000
 507 #define RDMA_CORE_CAP_PROT_RAW_PACKET   0x01000000
 508 #define RDMA_CORE_CAP_PROT_USNIC        0x02000000
 509
 510 #define RDMA_CORE_PORT_IBA_IB          (RDMA_CORE_CAP_PROT_IB  \
 511                                         | RDMA_CORE_CAP_IB_MAD \
 512                                         | RDMA_CORE_CAP_IB_SMI \
 513                                         | RDMA_CORE_CAP_IB_CM  \
 514                                         | RDMA_CORE_CAP_IB_SA  \
 515                                         | RDMA_CORE_CAP_AF_IB)
 516 #define RDMA_CORE_PORT_IBA_ROCE        (RDMA_CORE_CAP_PROT_ROCE \
 517                                         | RDMA_CORE_CAP_IB_MAD  \
 518                                         | RDMA_CORE_CAP_IB_CM   \
 519                                         | RDMA_CORE_CAP_AF_IB   \
 520                                         | RDMA_CORE_CAP_ETH_AH)
 521 #define RDMA_CORE_PORT_IBA_ROCE_UDP_ENCAP                       \
 522                                         (RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP \
 523                                         | RDMA_CORE_CAP_IB_MAD  \
 524                                         | RDMA_CORE_CAP_IB_CM   \
 525                                         | RDMA_CORE_CAP_AF_IB   \
 526                                         | RDMA_CORE_CAP_ETH_AH)
 527 #define RDMA_CORE_PORT_IWARP           (RDMA_CORE_CAP_PROT_IWARP \
 528                                         | RDMA_CORE_CAP_IW_CM)
 529 #define RDMA_CORE_PORT_INTEL_OPA       (RDMA_CORE_PORT_IBA_IB  \
 530                                         | RDMA_CORE_CAP_OPA_MAD)
 531
 532 #define RDMA_CORE_PORT_RAW_PACKET       (RDMA_CORE_CAP_PROT_RAW_PACKET)
 533
 534 #define RDMA_CORE_PORT_USNIC            (RDMA_CORE_CAP_PROT_USNIC)
 535
 536 struct ib_port_attr {
 537         u64                     subnet_prefix;
 538         enum ib_port_state      state;
 539         enum ib_mtu             max_mtu;
 540         enum ib_mtu             active_mtu;
 541         int                     gid_tbl_len;
 542         u32                     port_cap_flags;
 543         u32                     max_msg_sz;
 544         u32                     bad_pkey_cntr;
 545         u32                     qkey_viol_cntr;
 546         u16                     pkey_tbl_len;
 547         u16                     lid;
 548         u16                     sm_lid;
 549         u8                      lmc;
 550         u8                      max_vl_num;
 551         u8                      sm_sl;
 552         u8                      subnet_timeout;
 553         u8                      init_type_reply;
 554         u8                      active_width;
 555         u8                      active_speed;
 556         u8                      phys_state;
 557         bool                    grh_required;
 558 };
 559
 560 enum ib_device_modify_flags {
 561         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
 562         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
 563 };
 564
 565 #define IB_DEVICE_NODE_DESC_MAX 64
 566
 567 struct ib_device_modify {
 568         u64     sys_image_guid;
 569         char    node_desc[IB_DEVICE_NODE_DESC_MAX];
 570 };
 571
 572 enum ib_port_modify_flags {
 573         IB_PORT_SHUTDOWN                = 1,
 574         IB_PORT_INIT_TYPE               = (1<<2),
 575         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
 576 };
 577
 578 struct ib_port_modify {
 579         u32     set_port_cap_mask;
 580         u32     clr_port_cap_mask;
 581         u8      init_type;
 582 };
 583
 584 enum ib_event_type {
 585         IB_EVENT_CQ_ERR,
 586         IB_EVENT_QP_FATAL,
 587         IB_EVENT_QP_REQ_ERR,
 588         IB_EVENT_QP_ACCESS_ERR,
 589         IB_EVENT_COMM_EST,
 590         IB_EVENT_SQ_DRAINED,
 591         IB_EVENT_PATH_MIG,
 592         IB_EVENT_PATH_MIG_ERR,
 593         IB_EVENT_DEVICE_FATAL,
 594         IB_EVENT_PORT_ACTIVE,
 595         IB_EVENT_PORT_ERR,
 596         IB_EVENT_LID_CHANGE,
 597         IB_EVENT_PKEY_CHANGE,
 598         IB_EVENT_SM_CHANGE,
 599         IB_EVENT_SRQ_ERR,
 600         IB_EVENT_SRQ_LIMIT_REACHED,
 601         IB_EVENT_QP_LAST_WQE_REACHED,
 602         IB_EVENT_CLIENT_REREGISTER,
 603         IB_EVENT_GID_CHANGE,
 604         IB_EVENT_WQ_FATAL,
 605 };
 606
 607 const char *__attribute_const__ ib_event_msg(enum ib_event_type event);
 608
 609 struct ib_event {
 610         struct ib_device        *device;
 611         union {
 612                 struct ib_cq    *cq;
 613                 struct ib_qp    *qp;
 614                 struct ib_srq   *srq;
 615                 struct ib_wq    *wq;
 616                 u8              port_num;
 617         } element;
 618         enum ib_event_type      event;
 619 };
 620
 621 struct ib_event_handler {
 622         struct ib_device *device;
 623         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 624         struct list_head  list;
 625 };
 626
 627 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 628         do {                                                    \
 629                 (_ptr)->device  = _device;                      \
 630                 (_ptr)->handler = _handler;                     \
 631                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 632         } while (0)
 633
 634 struct ib_global_route {
 635         union ib_gid    dgid;
 636         u32             flow_label;
 637         u8              sgid_index;
 638         u8              hop_limit;
 639         u8              traffic_class;
 640 };
 641
 642 struct ib_grh {
 643         __be32          version_tclass_flow;
 644         __be16          paylen;
 645         u8              next_hdr;
 646         u8              hop_limit;
 647         union ib_gid    sgid;
 648         union ib_gid    dgid;
 649 };
 650
 651 union rdma_network_hdr {
 652         struct ib_grh ibgrh;
 653         struct {
 654                 /* The IB spec states that if it's IPv4, the header
 655                  * is located in the last 20 bytes of the header.
 656                  */
 657                 u8              reserved[20];
 658                 struct iphdr    roce4grh;
 659         };
 660 };
 661
 662 enum {
 663         IB_MULTICAST_QPN = 0xffffff
 664 };
 665
 666 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
 667 #define IB_MULTICAST_LID_BASE   cpu_to_be16(0xC000)
 668
 669 enum ib_ah_flags {
 670         IB_AH_GRH       = 1
 671 };
 672
 673 enum ib_rate {
 674         IB_RATE_PORT_CURRENT = 0,
 675         IB_RATE_2_5_GBPS = 2,
 676         IB_RATE_5_GBPS   = 5,
 677         IB_RATE_10_GBPS  = 3,
 678         IB_RATE_20_GBPS  = 6,
 679         IB_RATE_30_GBPS  = 4,
 680         IB_RATE_40_GBPS  = 7,
 681         IB_RATE_60_GBPS  = 8,
 682         IB_RATE_80_GBPS  = 9,
 683         IB_RATE_120_GBPS = 10,
 684         IB_RATE_14_GBPS  = 11,
 685         IB_RATE_56_GBPS  = 12,
 686         IB_RATE_112_GBPS = 13,
 687         IB_RATE_168_GBPS = 14,
 688         IB_RATE_25_GBPS  = 15,
 689         IB_RATE_100_GBPS = 16,
 690         IB_RATE_200_GBPS = 17,
 691         IB_RATE_300_GBPS = 18
 692 };
 693
 694 /**
 695  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
 696  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
 697  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
 698  * @rate: rate to convert.
 699  */
 700 __attribute_const__ int ib_rate_to_mult(enum ib_rate rate);
 701
 702 /**
 703  * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
 704  * For example, IB_RATE_2_5_GBPS will be converted to 2500.
 705  * @rate: rate to convert.
 706  */
 707 __attribute_const__ int ib_rate_to_mbps(enum ib_rate rate);
 708
 709
 710 /**
 711  * enum ib_mr_type - memory region type
 712  * @IB_MR_TYPE_MEM_REG:       memory region that is used for
 713  *                            normal registration
 714  * @IB_MR_TYPE_SIGNATURE:     memory region that is used for
 715  *                            signature operations (data-integrity
 716  *                            capable regions)
 717  * @IB_MR_TYPE_SG_GAPS:       memory region that is capable to
 718  *                            register any arbitrary sg lists (without
 719  *                            the normal mr constraints - see
 720  *                            ib_map_mr_sg)
 721  */
 722 enum ib_mr_type {
 723         IB_MR_TYPE_MEM_REG,
 724         IB_MR_TYPE_SIGNATURE,
 725         IB_MR_TYPE_SG_GAPS,
 726 };
 727
 728 /**
 729  * Signature types
 730  * IB_SIG_TYPE_NONE: Unprotected.
 731  * IB_SIG_TYPE_T10_DIF: Type T10-DIF
 732  */
 733 enum ib_signature_type {
 734         IB_SIG_TYPE_NONE,
 735         IB_SIG_TYPE_T10_DIF,
 736 };
 737
 738 /**
 739  * Signature T10-DIF block-guard types
 740  * IB_T10DIF_CRC: Corresponds to T10-PI mandated CRC checksum rules.
 741  * IB_T10DIF_CSUM: Corresponds to IP checksum rules.
 742  */
 743 enum ib_t10_dif_bg_type {
 744         IB_T10DIF_CRC,
 745         IB_T10DIF_CSUM
 746 };
 747
 748 /**
 749  * struct ib_t10_dif_domain - Parameters specific for T10-DIF
 750  *     domain.
 751  * @bg_type: T10-DIF block guard type (CRC|CSUM)
 752  * @pi_interval: protection information interval.
 753  * @bg: seed of guard computation.
 754  * @app_tag: application tag of guard block
 755  * @ref_tag: initial guard block reference tag.
 756  * @ref_remap: Indicate wethear the reftag increments each block
 757  * @app_escape: Indicate to skip block check if apptag=0xffff
 758  * @ref_escape: Indicate to skip block check if reftag=0xffffffff
 759  * @apptag_check_mask: check bitmask of application tag.
 760  */
 761 struct ib_t10_dif_domain {
 762         enum ib_t10_dif_bg_type bg_type;
 763         u16                     pi_interval;
 764         u16                     bg;
 765         u16                     app_tag;
 766         u32                     ref_tag;
 767         bool                    ref_remap;
 768         bool                    app_escape;
 769         bool                    ref_escape;
 770         u16                     apptag_check_mask;
 771 };
 772
 773 /**
 774  * struct ib_sig_domain - Parameters for signature domain
 775  * @sig_type: specific signauture type
 776  * @sig: union of all signature domain attributes that may
 777  *     be used to set domain layout.
 778  */
 779 struct ib_sig_domain {
 780         enum ib_signature_type sig_type;
 781         union {
 782                 struct ib_t10_dif_domain dif;
 783         } sig;
 784 };
 785
 786 /**
 787  * struct ib_sig_attrs - Parameters for signature handover operation
 788  * @check_mask: bitmask for signature byte check (8 bytes)
 789  * @mem: memory domain layout desciptor.
 790  * @wire: wire domain layout desciptor.
 791  */
 792 struct ib_sig_attrs {
 793         u8                      check_mask;
 794         struct ib_sig_domain    mem;
 795         struct ib_sig_domain    wire;
 796 };
 797
 798 enum ib_sig_err_type {
 799         IB_SIG_BAD_GUARD,
 800         IB_SIG_BAD_REFTAG,
 801         IB_SIG_BAD_APPTAG,
 802 };
 803
 804 /**
 805  * struct ib_sig_err - signature error descriptor
 806  */
 807 struct ib_sig_err {
 808         enum ib_sig_err_type    err_type;
 809         u32                     expected;
 810         u32                     actual;
 811         u64                     sig_err_offset;
 812         u32                     key;
 813 };
 814
 815 enum ib_mr_status_check {
 816         IB_MR_CHECK_SIG_STATUS = 1,
 817 };
 818
 819 /**
 820  * struct ib_mr_status - Memory region status container
 821  *
 822  * @fail_status: Bitmask of MR checks status. For each
 823  *     failed check a corresponding status bit is set.
 824  * @sig_err: Additional info for IB_MR_CEHCK_SIG_STATUS
 825  *     failure.
 826  */
 827 struct ib_mr_status {
 828         u32                 fail_status;
 829         struct ib_sig_err   sig_err;
 830 };
 831
 832 /**
 833  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
 834  * enum.
 835  * @mult: multiple to convert.
 836  */
 837 __attribute_const__ enum ib_rate mult_to_ib_rate(int mult);
 838
 839 struct ib_ah_attr {
 840         struct ib_global_route  grh;
 841         u16                     dlid;
 842         u8                      sl;
 843         u8                      src_path_bits;
 844         u8                      static_rate;
 845         u8                      ah_flags;
 846         u8                      port_num;
 847         u8                      dmac[ETH_ALEN];
 848 };
 849
 850 enum ib_wc_status {
 851         IB_WC_SUCCESS,
 852         IB_WC_LOC_LEN_ERR,
 853         IB_WC_LOC_QP_OP_ERR,
 854         IB_WC_LOC_EEC_OP_ERR,
 855         IB_WC_LOC_PROT_ERR,
 856         IB_WC_WR_FLUSH_ERR,
 857         IB_WC_MW_BIND_ERR,
 858         IB_WC_BAD_RESP_ERR,
 859         IB_WC_LOC_ACCESS_ERR,
 860         IB_WC_REM_INV_REQ_ERR,
 861         IB_WC_REM_ACCESS_ERR,
 862         IB_WC_REM_OP_ERR,
 863         IB_WC_RETRY_EXC_ERR,
 864         IB_WC_RNR_RETRY_EXC_ERR,
 865         IB_WC_LOC_RDD_VIOL_ERR,
 866         IB_WC_REM_INV_RD_REQ_ERR,
 867         IB_WC_REM_ABORT_ERR,
 868         IB_WC_INV_EECN_ERR,
 869         IB_WC_INV_EEC_STATE_ERR,
 870         IB_WC_FATAL_ERR,
 871         IB_WC_RESP_TIMEOUT_ERR,
 872         IB_WC_GENERAL_ERR
 873 };
 874
 875 const char *__attribute_const__ ib_wc_status_msg(enum ib_wc_status status);
 876
 877 enum ib_wc_opcode {
 878         IB_WC_SEND,
 879         IB_WC_RDMA_WRITE,
 880         IB_WC_RDMA_READ,
 881         IB_WC_COMP_SWAP,
 882         IB_WC_FETCH_ADD,
 883         IB_WC_LSO,
 884         IB_WC_LOCAL_INV,
 885         IB_WC_REG_MR,
 886         IB_WC_MASKED_COMP_SWAP,
 887         IB_WC_MASKED_FETCH_ADD,
 888 /*
 889  * Set value of IB_WC_RECV so consumers can test if a completion is a
 890  * receive by testing (opcode & IB_WC_RECV).
 891  */
 892         IB_WC_RECV                      = 1 << 7,
 893         IB_WC_RECV_RDMA_WITH_IMM
 894 };
 895
 896 enum ib_wc_flags {
 897         IB_WC_GRH               = 1,
 898         IB_WC_WITH_IMM          = (1<<1),
 899         IB_WC_WITH_INVALIDATE   = (1<<2),
 900         IB_WC_IP_CSUM_OK        = (1<<3),
 901         IB_WC_WITH_SMAC         = (1<<4),
 902         IB_WC_WITH_VLAN         = (1<<5),
 903         IB_WC_WITH_NETWORK_HDR_TYPE     = (1<<6),
 904 };
 905
 906 struct ib_wc {
 907         union {
 908                 u64             wr_id;
 909                 struct ib_cqe   *wr_cqe;
 910         };
 911         enum ib_wc_status       status;
 912         enum ib_wc_opcode       opcode;
 913         u32                     vendor_err;
 914         u32                     byte_len;
 915         struct ib_qp           *qp;
 916         union {
 917                 __be32          imm_data;
 918                 u32             invalidate_rkey;
 919         } ex;
 920         u32                     src_qp;
 921         int                     wc_flags;
 922         u16                     pkey_index;
 923         u16                     slid;
 924         u8                      sl;
 925         u8                      dlid_path_bits;
 926         u8                      port_num;       /* valid only for DR SMPs on switches */
 927         u8                      smac[ETH_ALEN];
 928         u16                     vlan_id;
 929         u8                      network_hdr_type;
 930 };
 931
 932 enum ib_cq_notify_flags {
 933         IB_CQ_SOLICITED                 = 1 << 0,
 934         IB_CQ_NEXT_COMP                 = 1 << 1,
 935         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
 936         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
 937 };
 938
 939 enum ib_srq_type {
 940         IB_SRQT_BASIC,
 941         IB_SRQT_XRC
 942 };
 943
 944 enum ib_srq_attr_mask {
 945         IB_SRQ_MAX_WR   = 1 << 0,
 946         IB_SRQ_LIMIT    = 1 << 1,
 947 };
 948
 949 struct ib_srq_attr {
 950         u32     max_wr;
 951         u32     max_sge;
 952         u32     srq_limit;
 953 };
 954
 955 struct ib_srq_init_attr {
 956         void                  (*event_handler)(struct ib_event *, void *);
 957         void                   *srq_context;
 958         struct ib_srq_attr      attr;
 959         enum ib_srq_type        srq_type;
 960
 961         union {
 962                 struct {
 963                         struct ib_xrcd *xrcd;
 964                         struct ib_cq   *cq;
 965                 } xrc;
 966         } ext;
 967 };
 968
 969 struct ib_qp_cap {
 970         u32     max_send_wr;
 971         u32     max_recv_wr;
 972         u32     max_send_sge;
 973         u32     max_recv_sge;
 974         u32     max_inline_data;
 975
 976         /*
 977          * Maximum number of rdma_rw_ctx structures in flight at a time.
 978          * ib_create_qp() will calculate the right amount of neededed WRs
 979          * and MRs based on this.
 980          */
 981         u32     max_rdma_ctxs;
 982 };
 983
 984 enum ib_sig_type {
 985         IB_SIGNAL_ALL_WR,
 986         IB_SIGNAL_REQ_WR
 987 };
 988
 989 enum ib_qp_type {
 990         /*
 991          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
 992          * here (and in that order) since the MAD layer uses them as
 993          * indices into a 2-entry table.
 994          */
 995         IB_QPT_SMI,
 996         IB_QPT_GSI,
 997
 998         IB_QPT_RC,
 999         IB_QPT_UC,
1000         IB_QPT_UD,
1001         IB_QPT_RAW_IPV6,
1002         IB_QPT_RAW_ETHERTYPE,
1003         IB_QPT_RAW_PACKET = 8,
1004         IB_QPT_XRC_INI = 9,
1005         IB_QPT_XRC_TGT,
1006         IB_QPT_MAX,
1007         /* Reserve a range for qp types internal to the low level driver.
1008          * These qp types will not be visible at the IB core layer, so the
1009          * IB_QPT_MAX usages should not be affected in the core layer
1010          */
1011         IB_QPT_RESERVED1 = 0x1000,
1012         IB_QPT_RESERVED2,
1013         IB_QPT_RESERVED3,
1014         IB_QPT_RESERVED4,
1015         IB_QPT_RESERVED5,
1016         IB_QPT_RESERVED6,
1017         IB_QPT_RESERVED7,
1018         IB_QPT_RESERVED8,
1019         IB_QPT_RESERVED9,
1020         IB_QPT_RESERVED10,
1021 };
1022
1023 enum ib_qp_create_flags {
1024         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
1025         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
1026         IB_QP_CREATE_CROSS_CHANNEL              = 1 << 2,
1027         IB_QP_CREATE_MANAGED_SEND               = 1 << 3,
1028         IB_QP_CREATE_MANAGED_RECV               = 1 << 4,
1029         IB_QP_CREATE_NETIF_QP                   = 1 << 5,
1030         IB_QP_CREATE_SIGNATURE_EN               = 1 << 6,
1031         IB_QP_CREATE_USE_GFP_NOIO               = 1 << 7,
1032         IB_QP_CREATE_SCATTER_FCS                = 1 << 8,
1033         IB_QP_CREATE_CVLAN_STRIPPING            = 1 << 9,
1034         /* reserve bits 26-31 for low level drivers' internal use */
1035         IB_QP_CREATE_RESERVED_START             = 1 << 26,
1036         IB_QP_CREATE_RESERVED_END               = 1 << 31,
1037 };
1038
1039 /*
1040  * Note: users may not call ib_close_qp or ib_destroy_qp from the event_handler
1041  * callback to destroy the passed in QP.
1042  */
1043
1044 struct ib_qp_init_attr {
1045         void                  (*event_handler)(struct ib_event *, void *);
1046         void                   *qp_context;
1047         struct ib_cq           *send_cq;
1048         struct ib_cq           *recv_cq;
1049         struct ib_srq          *srq;
1050         struct ib_xrcd         *xrcd;     /* XRC TGT QPs only */
1051         struct ib_qp_cap        cap;
1052         enum ib_sig_type        sq_sig_type;
1053         enum ib_qp_type         qp_type;
1054         enum ib_qp_create_flags create_flags;
1055
1056         /*
1057          * Only needed for special QP types, or when using the RW API.
1058          */
1059         u8                      port_num;
1060         struct ib_rwq_ind_table *rwq_ind_tbl;
1061 };
1062
1063 struct ib_qp_open_attr {
1064         void                  (*event_handler)(struct ib_event *, void *);
1065         void                   *qp_context;
1066         u32                     qp_num;
1067         enum ib_qp_type         qp_type;
1068 };
1069
1070 enum ib_rnr_timeout {
1071         IB_RNR_TIMER_655_36 =  0,
1072         IB_RNR_TIMER_000_01 =  1,
1073         IB_RNR_TIMER_000_02 =  2,
1074         IB_RNR_TIMER_000_03 =  3,
1075         IB_RNR_TIMER_000_04 =  4,
1076         IB_RNR_TIMER_000_06 =  5,
1077         IB_RNR_TIMER_000_08 =  6,
1078         IB_RNR_TIMER_000_12 =  7,
1079         IB_RNR_TIMER_000_16 =  8,
1080         IB_RNR_TIMER_000_24 =  9,
1081         IB_RNR_TIMER_000_32 = 10,
1082         IB_RNR_TIMER_000_48 = 11,
1083         IB_RNR_TIMER_000_64 = 12,
1084         IB_RNR_TIMER_000_96 = 13,
1085         IB_RNR_TIMER_001_28 = 14,
1086         IB_RNR_TIMER_001_92 = 15,
1087         IB_RNR_TIMER_002_56 = 16,
1088         IB_RNR_TIMER_003_84 = 17,
1089         IB_RNR_TIMER_005_12 = 18,
1090         IB_RNR_TIMER_007_68 = 19,
1091         IB_RNR_TIMER_010_24 = 20,
1092         IB_RNR_TIMER_015_36 = 21,
1093         IB_RNR_TIMER_020_48 = 22,
1094         IB_RNR_TIMER_030_72 = 23,
1095         IB_RNR_TIMER_040_96 = 24,
1096         IB_RNR_TIMER_061_44 = 25,
1097         IB_RNR_TIMER_081_92 = 26,
1098         IB_RNR_TIMER_122_88 = 27,
1099         IB_RNR_TIMER_163_84 = 28,
1100         IB_RNR_TIMER_245_76 = 29,
1101         IB_RNR_TIMER_327_68 = 30,
1102         IB_RNR_TIMER_491_52 = 31
1103 };
1104
1105 enum ib_qp_attr_mask {
1106         IB_QP_STATE                     = 1,
1107         IB_QP_CUR_STATE                 = (1<<1),
1108         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
1109         IB_QP_ACCESS_FLAGS              = (1<<3),
1110         IB_QP_PKEY_INDEX                = (1<<4),
1111         IB_QP_PORT                      = (1<<5),
1112         IB_QP_QKEY                      = (1<<6),
1113         IB_QP_AV                        = (1<<7),
1114         IB_QP_PATH_MTU                  = (1<<8),
1115         IB_QP_TIMEOUT                   = (1<<9),
1116         IB_QP_RETRY_CNT                 = (1<<10),
1117         IB_QP_RNR_RETRY                 = (1<<11),
1118         IB_QP_RQ_PSN                    = (1<<12),
1119         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
1120         IB_QP_ALT_PATH                  = (1<<14),
1121         IB_QP_MIN_RNR_TIMER             = (1<<15),
1122         IB_QP_SQ_PSN                    = (1<<16),
1123         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
1124         IB_QP_PATH_MIG_STATE            = (1<<18),
1125         IB_QP_CAP                       = (1<<19),
1126         IB_QP_DEST_QPN                  = (1<<20),
1127         IB_QP_RESERVED1                 = (1<<21),
1128         IB_QP_RESERVED2                 = (1<<22),
1129         IB_QP_RESERVED3                 = (1<<23),
1130         IB_QP_RESERVED4                 = (1<<24),
1131         IB_QP_RATE_LIMIT                = (1<<25),
1132 };
1133
1134 enum ib_qp_state {
1135         IB_QPS_RESET,
1136         IB_QPS_INIT,
1137         IB_QPS_RTR,
1138         IB_QPS_RTS,
1139         IB_QPS_SQD,
1140         IB_QPS_SQE,
1141         IB_QPS_ERR
1142 };
1143
1144 enum ib_mig_state {
1145         IB_MIG_MIGRATED,
1146         IB_MIG_REARM,
1147         IB_MIG_ARMED
1148 };
1149
1150 enum ib_mw_type {
1151         IB_MW_TYPE_1 = 1,
1152         IB_MW_TYPE_2 = 2
1153 };
1154
1155 struct ib_qp_attr {
1156         enum ib_qp_state        qp_state;
1157         enum ib_qp_state        cur_qp_state;
1158         enum ib_mtu             path_mtu;
1159         enum ib_mig_state       path_mig_state;
1160         u32                     qkey;
1161         u32                     rq_psn;
1162         u32                     sq_psn;
1163         u32                     dest_qp_num;
1164         int                     qp_access_flags;
1165         struct ib_qp_cap        cap;
1166         struct ib_ah_attr       ah_attr;
1167         struct ib_ah_attr       alt_ah_attr;
1168         u16                     pkey_index;
1169         u16                     alt_pkey_index;
1170         u8                      en_sqd_async_notify;
1171         u8                      sq_draining;
1172         u8                      max_rd_atomic;
1173         u8                      max_dest_rd_atomic;
1174         u8                      min_rnr_timer;
1175         u8                      port_num;
1176         u8                      timeout;
1177         u8                      retry_cnt;
1178         u8                      rnr_retry;
1179         u8                      alt_port_num;
1180         u8                      alt_timeout;
1181         u32                     rate_limit;
1182 };
1183
1184 enum ib_wr_opcode {
1185         IB_WR_RDMA_WRITE,
1186         IB_WR_RDMA_WRITE_WITH_IMM,
1187         IB_WR_SEND,
1188         IB_WR_SEND_WITH_IMM,
1189         IB_WR_RDMA_READ,
1190         IB_WR_ATOMIC_CMP_AND_SWP,
1191         IB_WR_ATOMIC_FETCH_AND_ADD,
1192         IB_WR_LSO,
1193         IB_WR_SEND_WITH_INV,
1194         IB_WR_RDMA_READ_WITH_INV,
1195         IB_WR_LOCAL_INV,
1196         IB_WR_REG_MR,
1197         IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
1198         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
1199         IB_WR_REG_SIG_MR,
1200         /* reserve values for low level drivers' internal use.
1201          * These values will not be used at all in the ib core layer.
1202          */
1203         IB_WR_RESERVED1 = 0xf0,
1204         IB_WR_RESERVED2,
1205         IB_WR_RESERVED3,
1206         IB_WR_RESERVED4,
1207         IB_WR_RESERVED5,
1208         IB_WR_RESERVED6,
1209         IB_WR_RESERVED7,
1210         IB_WR_RESERVED8,
1211         IB_WR_RESERVED9,
1212         IB_WR_RESERVED10,
1213 };
1214
1215 enum ib_send_flags {
1216         IB_SEND_FENCE           = 1,
1217         IB_SEND_SIGNALED        = (1<<1),
1218         IB_SEND_SOLICITED       = (1<<2),
1219         IB_SEND_INLINE          = (1<<3),
1220         IB_SEND_IP_CSUM         = (1<<4),
1221
1222         /* reserve bits 26-31 for low level drivers' internal use */
1223         IB_SEND_RESERVED_START  = (1 << 26),
1224         IB_SEND_RESERVED_END    = (1 << 31),
1225 };
1226
1227 struct ib_sge {
1228         u64     addr;
1229         u32     length;
1230         u32     lkey;
1231 };
1232
1233 struct ib_cqe {
1234         void (*done)(struct ib_cq *cq, struct ib_wc *wc);
1235 };
1236
1237 struct ib_send_wr {
1238         struct ib_send_wr      *next;
1239         union {
1240                 u64             wr_id;
1241                 struct ib_cqe   *wr_cqe;
1242         };
1243         struct ib_sge          *sg_list;
1244         int                     num_sge;
1245         enum ib_wr_opcode       opcode;
1246         int                     send_flags;
1247         union {
1248                 __be32          imm_data;
1249                 u32             invalidate_rkey;
1250         } ex;
1251 };
1252
1253 struct ib_rdma_wr {
1254         struct ib_send_wr       wr;
1255         u64                     remote_addr;
1256         u32                     rkey;
1257 };
1258
1259 static inline struct ib_rdma_wr *rdma_wr(struct ib_send_wr *wr)
1260 {
1261         return container_of(wr, struct ib_rdma_wr, wr);
1262 }
1263
1264 struct ib_atomic_wr {
1265         struct ib_send_wr       wr;
1266         u64                     remote_addr;
1267         u64                     compare_add;
1268         u64                     swap;
1269         u64                     compare_add_mask;
1270         u64                     swap_mask;
1271         u32                     rkey;
1272 };
1273
1274 static inline struct ib_atomic_wr *atomic_wr(struct ib_send_wr *wr)
1275 {
1276         return container_of(wr, struct ib_atomic_wr, wr);
1277 }
1278
1279 struct ib_ud_wr {
1280         struct ib_send_wr       wr;
1281         struct ib_ah            *ah;
1282         void                    *header;
1283         int                     hlen;
1284         int                     mss;
1285         u32                     remote_qpn;
1286         u32                     remote_qkey;
1287         u16                     pkey_index; /* valid for GSI only */
1288         u8                      port_num;   /* valid for DR SMPs on switch only */
1289 };
1290
1291 static inline struct ib_ud_wr *ud_wr(struct ib_send_wr *wr)
1292 {
1293         return container_of(wr, struct ib_ud_wr, wr);
1294 }
1295
1296 struct ib_reg_wr {
1297         struct ib_send_wr       wr;
1298         struct ib_mr            *mr;
1299         u32                     key;
1300         int                     access;
1301 };
1302
1303 static inline struct ib_reg_wr *reg_wr(struct ib_send_wr *wr)
1304 {
1305         return container_of(wr, struct ib_reg_wr, wr);
1306 }
1307
1308 struct ib_sig_handover_wr {
1309         struct ib_send_wr       wr;
1310         struct ib_sig_attrs    *sig_attrs;
1311         struct ib_mr           *sig_mr;
1312         int                     access_flags;
1313         struct ib_sge          *prot;
1314 };
1315
1316 static inline struct ib_sig_handover_wr *sig_handover_wr(struct ib_send_wr *wr)
1317 {
1318         return container_of(wr, struct ib_sig_handover_wr, wr);
1319 }
1320
1321 struct ib_recv_wr {
1322         struct ib_recv_wr      *next;
1323         union {
1324                 u64             wr_id;
1325                 struct ib_cqe   *wr_cqe;
1326         };
1327         struct ib_sge          *sg_list;
1328         int                     num_sge;
1329 };
1330
1331 enum ib_access_flags {
1332         IB_ACCESS_LOCAL_WRITE   = 1,
1333         IB_ACCESS_REMOTE_WRITE  = (1<<1),
1334         IB_ACCESS_REMOTE_READ   = (1<<2),
1335         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
1336         IB_ACCESS_MW_BIND       = (1<<4),
1337         IB_ZERO_BASED           = (1<<5),
1338         IB_ACCESS_ON_DEMAND     = (1<<6),
1339 };
1340
1341 /*
1342  * XXX: these are apparently used for ->rereg_user_mr, no idea why they
1343  * are hidden here instead of a uapi header!
1344  */
1345 enum ib_mr_rereg_flags {
1346         IB_MR_REREG_TRANS       = 1,
1347         IB_MR_REREG_PD          = (1<<1),
1348         IB_MR_REREG_ACCESS      = (1<<2),
1349         IB_MR_REREG_SUPPORTED   = ((IB_MR_REREG_ACCESS << 1) - 1)
1350 };
1351
1352 struct ib_fmr_attr {
1353         int     max_pages;
1354         int     max_maps;
1355         u8      page_shift;
1356 };
1357
1358 struct ib_umem;
1359
1360 enum rdma_remove_reason {
1361         /* Userspace requested uobject deletion. Call could fail */
1362         RDMA_REMOVE_DESTROY,
1363         /* Context deletion. This call should delete the actual object itself */
1364         RDMA_REMOVE_CLOSE,
1365         /* Driver is being hot-unplugged. This call should delete the actual object itself */
1366         RDMA_REMOVE_DRIVER_REMOVE,
1367         /* Context is being cleaned-up, but commit was just completed */
1368         RDMA_REMOVE_DURING_CLEANUP,
1369 };
1370
1371 struct ib_rdmacg_object {
1372 #ifdef CONFIG_CGROUP_RDMA
1373         struct rdma_cgroup      *cg;            /* owner rdma cgroup */
1374 #endif
1375 };
1376
1377 struct ib_ucontext {
1378         struct ib_device       *device;
1379         struct ib_uverbs_file  *ufile;
1380         int                     closing;
1381
1382         /* locking the uobjects_list */
1383         struct mutex            uobjects_lock;
1384         struct list_head        uobjects;
1385         /* protects cleanup process from other actions */
1386         struct rw_semaphore     cleanup_rwsem;
1387         enum rdma_remove_reason cleanup_reason;
1388
1389         struct pid             *tgid;
1390 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
1391         struct rb_root      umem_tree;
1392         /*
1393          * Protects .umem_rbroot and tree, as well as odp_mrs_count and
1394          * mmu notifiers registration.
1395          */
1396         struct rw_semaphore     umem_rwsem;
1397         void (*invalidate_range)(struct ib_umem *umem,
1398                                  unsigned long start, unsigned long end);
1399
1400         struct mmu_notifier     mn;
1401         atomic_t                notifier_count;
1402         /* A list of umems that don't have private mmu notifier counters yet. */
1403         struct list_head        no_private_counters;
1404         int                     odp_mrs_count;
1405 #endif
1406
1407         struct ib_rdmacg_object cg_obj;
1408 };
1409
1410 struct ib_uobject {
1411         u64                     user_handle;    /* handle given to us by userspace */
1412         struct ib_ucontext     *context;        /* associated user context */
1413         void                   *object;         /* containing object */
1414         struct list_head        list;           /* link to context's list */
1415         struct ib_rdmacg_object cg_obj;         /* rdmacg object */
1416         int                     id;             /* index into kernel idr */
1417         struct kref             ref;
1418         atomic_t                usecnt;         /* protects exclusive access */
1419         struct rcu_head         rcu;            /* kfree_rcu() overhead */
1420
1421         const struct uverbs_obj_type *type;
1422 };
1423
1424 struct ib_uobject_file {
1425         struct ib_uobject       uobj;
1426         /* ufile contains the lock between context release and file close */
1427         struct ib_uverbs_file   *ufile;
1428 };
1429
1430 struct ib_udata {
1431         const void __user *inbuf;
1432         void __user *outbuf;
1433         size_t       inlen;
1434         size_t       outlen;
1435 };
1436
1437 struct ib_pd {
1438         u32                     local_dma_lkey;
1439         u32                     flags;
1440         struct ib_device       *device;
1441         struct ib_uobject      *uobject;
1442         atomic_t                usecnt; /* count all resources */
1443
1444         u32                     unsafe_global_rkey;
1445
1446         /*
1447          * Implementation details of the RDMA core, don't use in drivers:
1448          */
1449         struct ib_mr           *__internal_mr;
1450 };
1451
1452 struct ib_xrcd {
1453         struct ib_device       *device;
1454         atomic_t                usecnt; /* count all exposed resources */
1455         struct inode           *inode;
1456
1457         struct mutex            tgt_qp_mutex;
1458         struct list_head        tgt_qp_list;
1459 };
1460
1461 struct ib_ah {
1462         struct ib_device        *device;
1463         struct ib_pd            *pd;
1464         struct ib_uobject       *uobject;
1465 };
1466
1467 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
1468
1469 enum ib_poll_context {
1470         IB_POLL_DIRECT,         /* caller context, no hw completions */
1471         IB_POLL_SOFTIRQ,        /* poll from softirq context */
1472         IB_POLL_WORKQUEUE,      /* poll from workqueue */
1473 };
1474
1475 struct ib_cq {
1476         struct ib_device       *device;
1477         struct ib_uobject      *uobject;
1478         ib_comp_handler         comp_handler;
1479         void                  (*event_handler)(struct ib_event *, void *);
1480         void                   *cq_context;
1481         int                     cqe;
1482         atomic_t                usecnt; /* count number of work queues */
1483         enum ib_poll_context    poll_ctx;
1484         struct ib_wc            *wc;
1485         union {
1486                 struct irq_poll         iop;
1487                 struct work_struct      work;
1488         };
1489 };
1490
1491 struct ib_srq {
1492         struct ib_device       *device;
1493         struct ib_pd           *pd;
1494         struct ib_uobject      *uobject;
1495         void                  (*event_handler)(struct ib_event *, void *);
1496         void                   *srq_context;
1497         enum ib_srq_type        srq_type;
1498         atomic_t                usecnt;
1499
1500         union {
1501                 struct {
1502                         struct ib_xrcd *xrcd;
1503                         struct ib_cq   *cq;
1504                         u32             srq_num;
1505                 } xrc;
1506         } ext;
1507 };
1508
1509 enum ib_raw_packet_caps {
1510         /* Strip cvlan from incoming packet and report it in the matching work
1511          * completion is supported.
1512          */
1513         IB_RAW_PACKET_CAP_CVLAN_STRIPPING       = (1 << 0),
1514         /* Scatter FCS field of an incoming packet to host memory is supported.
1515          */
1516         IB_RAW_PACKET_CAP_SCATTER_FCS           = (1 << 1),
1517         /* Checksum offloads are supported (for both send and receive). */
1518         IB_RAW_PACKET_CAP_IP_CSUM               = (1 << 2),
1519 };
1520
1521 enum ib_wq_type {
1522         IB_WQT_RQ
1523 };
1524
1525 enum ib_wq_state {
1526         IB_WQS_RESET,
1527         IB_WQS_RDY,
1528         IB_WQS_ERR
1529 };
1530
1531 struct ib_wq {
1532         struct ib_device       *device;
1533         struct ib_uobject      *uobject;
1534         void                *wq_context;
1535         void                (*event_handler)(struct ib_event *, void *);
1536         struct ib_pd           *pd;
1537         struct ib_cq           *cq;
1538         u32             wq_num;
1539         enum ib_wq_state       state;
1540         enum ib_wq_type wq_type;
1541         atomic_t                usecnt;
1542 };
1543
1544 enum ib_wq_flags {
1545         IB_WQ_FLAGS_CVLAN_STRIPPING     = 1 << 0,
1546         IB_WQ_FLAGS_SCATTER_FCS         = 1 << 1,
1547 };
1548
1549 struct ib_wq_init_attr {
1550         void                   *wq_context;
1551         enum ib_wq_type wq_type;
1552         u32             max_wr;
1553         u32             max_sge;
1554         struct  ib_cq          *cq;
1555         void                (*event_handler)(struct ib_event *, void *);
1556         u32             create_flags; /* Use enum ib_wq_flags */
1557 };
1558
1559 enum ib_wq_attr_mask {
1560         IB_WQ_STATE             = 1 << 0,
1561         IB_WQ_CUR_STATE         = 1 << 1,
1562         IB_WQ_FLAGS             = 1 << 2,
1563 };
1564
1565 struct ib_wq_attr {
1566         enum    ib_wq_state     wq_state;
1567         enum    ib_wq_state     curr_wq_state;
1568         u32                     flags; /* Use enum ib_wq_flags */
1569         u32                     flags_mask; /* Use enum ib_wq_flags */
1570 };
1571
1572 struct ib_rwq_ind_table {
1573         struct ib_device        *device;
1574         struct ib_uobject      *uobject;
1575         atomic_t                usecnt;
1576         u32             ind_tbl_num;
1577         u32             log_ind_tbl_size;
1578         struct ib_wq    **ind_tbl;
1579 };
1580
1581 struct ib_rwq_ind_table_init_attr {
1582         u32             log_ind_tbl_size;
1583         /* Each entry is a pointer to Receive Work Queue */
1584         struct ib_wq    **ind_tbl;
1585 };
1586
1587 /*
1588  * @max_write_sge: Maximum SGE elements per RDMA WRITE request.
1589  * @max_read_sge:  Maximum SGE elements per RDMA READ request.
1590  */
1591 struct ib_qp {
1592         struct ib_device       *device;
1593         struct ib_pd           *pd;
1594         struct ib_cq           *send_cq;
1595         struct ib_cq           *recv_cq;
1596         spinlock_t              mr_lock;
1597         int                     mrs_used;
1598         struct list_head        rdma_mrs;
1599         struct list_head        sig_mrs;
1600         struct ib_srq          *srq;
1601         struct ib_xrcd         *xrcd; /* XRC TGT QPs only */
1602         struct list_head        xrcd_list;
1603
1604         /* count times opened, mcast attaches, flow attaches */
1605         atomic_t                usecnt;
1606         struct list_head        open_list;
1607         struct ib_qp           *real_qp;
1608         struct ib_uobject      *uobject;
1609         void                  (*event_handler)(struct ib_event *, void *);
1610         void                   *qp_context;
1611         u32                     qp_num;
1612         u32                     max_write_sge;
1613         u32                     max_read_sge;
1614         enum ib_qp_type         qp_type;
1615         struct ib_rwq_ind_table *rwq_ind_tbl;
1616 };
1617
1618 struct ib_mr {
1619         struct ib_device  *device;
1620         struct ib_pd      *pd;
1621         u32                lkey;
1622         u32                rkey;
1623         u64                iova;
1624         u32                length;
1625         unsigned int       page_size;
1626         bool               need_inval;
1627         union {
1628                 struct ib_uobject       *uobject;       /* user */
1629                 struct list_head        qp_entry;       /* FR */
1630         };
1631 };
1632
1633 struct ib_mw {
1634         struct ib_device        *device;
1635         struct ib_pd            *pd;
1636         struct ib_uobject       *uobject;
1637         u32                     rkey;
1638         enum ib_mw_type         type;
1639 };
1640
1641 struct ib_fmr {
1642         struct ib_device        *device;
1643         struct ib_pd            *pd;
1644         struct list_head        list;
1645         u32                     lkey;
1646         u32                     rkey;
1647 };
1648
1649 /* Supported steering options */
1650 enum ib_flow_attr_type {
1651         /* steering according to rule specifications */
1652         IB_FLOW_ATTR_NORMAL             = 0x0,
1653         /* default unicast and multicast rule -
1654          * receive all Eth traffic which isn't steered to any QP
1655          */
1656         IB_FLOW_ATTR_ALL_DEFAULT        = 0x1,
1657         /* default multicast rule -
1658          * receive all Eth multicast traffic which isn't steered to any QP
1659          */
1660         IB_FLOW_ATTR_MC_DEFAULT         = 0x2,
1661         /* sniffer rule - receive all port traffic */
1662         IB_FLOW_ATTR_SNIFFER            = 0x3
1663 };
1664
1665 /* Supported steering header types */
1666 enum ib_flow_spec_type {
1667         /* L2 headers*/
1668         IB_FLOW_SPEC_ETH                = 0x20,
1669         IB_FLOW_SPEC_IB                 = 0x22,
1670         /* L3 header*/
1671         IB_FLOW_SPEC_IPV4               = 0x30,
1672         IB_FLOW_SPEC_IPV6               = 0x31,
1673         /* L4 headers*/
1674         IB_FLOW_SPEC_TCP                = 0x40,
1675         IB_FLOW_SPEC_UDP                = 0x41,
1676         IB_FLOW_SPEC_VXLAN_TUNNEL       = 0x50,
1677         IB_FLOW_SPEC_INNER              = 0x100,
1678         /* Actions */
1679         IB_FLOW_SPEC_ACTION_TAG         = 0x1000,
1680 };
1681 #define IB_FLOW_SPEC_LAYER_MASK 0xF0
1682 #define IB_FLOW_SPEC_SUPPORT_LAYERS 8
1683
1684 /* Flow steering rule priority is set according to it's domain.
1685  * Lower domain value means higher priority.
1686  */
1687 enum ib_flow_domain {
1688         IB_FLOW_DOMAIN_USER,
1689         IB_FLOW_DOMAIN_ETHTOOL,
1690         IB_FLOW_DOMAIN_RFS,
1691         IB_FLOW_DOMAIN_NIC,
1692         IB_FLOW_DOMAIN_NUM /* Must be last */
1693 };
1694
1695 enum ib_flow_flags {
1696         IB_FLOW_ATTR_FLAGS_DONT_TRAP = 1UL << 1, /* Continue match, no steal */
1697         IB_FLOW_ATTR_FLAGS_RESERVED  = 1UL << 2  /* Must be last */
1698 };
1699
1700 struct ib_flow_eth_filter {
1701         u8      dst_mac[6];
1702         u8      src_mac[6];
1703         __be16  ether_type;
1704         __be16  vlan_tag;
1705         /* Must be last */
1706         u8      real_sz[0];
1707 };
1708
1709 struct ib_flow_spec_eth {
1710         u32                       type;
1711         u16                       size;
1712         struct ib_flow_eth_filter val;
1713         struct ib_flow_eth_filter mask;
1714 };
1715
1716 struct ib_flow_ib_filter {
1717         __be16 dlid;
1718         __u8   sl;
1719         /* Must be last */
1720         u8      real_sz[0];
1721 };
1722
1723 struct ib_flow_spec_ib {
1724         u32                      type;
1725         u16                      size;
1726         struct ib_flow_ib_filter val;
1727         struct ib_flow_ib_filter mask;
1728 };
1729
1730 /* IPv4 header flags */
1731 enum ib_ipv4_flags {
1732         IB_IPV4_DONT_FRAG = 0x2, /* Don't enable packet fragmentation */
1733         IB_IPV4_MORE_FRAG = 0X4  /* For All fragmented packets except the
1734                                     last have this flag set */
1735 };
1736
1737 struct ib_flow_ipv4_filter {
1738         __be32  src_ip;
1739         __be32  dst_ip;
1740         u8      proto;
1741         u8      tos;
1742         u8      ttl;
1743         u8      flags;
1744         /* Must be last */
1745         u8      real_sz[0];
1746 };
1747
1748 struct ib_flow_spec_ipv4 {
1749         u32                        type;
1750         u16                        size;
1751         struct ib_flow_ipv4_filter val;
1752         struct ib_flow_ipv4_filter mask;
1753 };
1754
1755 struct ib_flow_ipv6_filter {
1756         u8      src_ip[16];
1757         u8      dst_ip[16];
1758         __be32  flow_label;
1759         u8      next_hdr;
1760         u8      traffic_class;
1761         u8      hop_limit;
1762         /* Must be last */
1763         u8      real_sz[0];
1764 };
1765
1766 struct ib_flow_spec_ipv6 {
1767         u32                        type;
1768         u16                        size;
1769         struct ib_flow_ipv6_filter val;
1770         struct ib_flow_ipv6_filter mask;
1771 };
1772
1773 struct ib_flow_tcp_udp_filter {
1774         __be16  dst_port;
1775         __be16  src_port;
1776         /* Must be last */
1777         u8      real_sz[0];
1778 };
1779
1780 struct ib_flow_spec_tcp_udp {
1781         u32                           type;
1782         u16                           size;
1783         struct ib_flow_tcp_udp_filter val;
1784         struct ib_flow_tcp_udp_filter mask;
1785 };
1786
1787 struct ib_flow_tunnel_filter {
1788         __be32  tunnel_id;
1789         u8      real_sz[0];
1790 };
1791
1792 /* ib_flow_spec_tunnel describes the Vxlan tunnel
1793  * the tunnel_id from val has the vni value
1794  */
1795 struct ib_flow_spec_tunnel {
1796         u32                           type;
1797         u16                           size;
1798         struct ib_flow_tunnel_filter  val;
1799         struct ib_flow_tunnel_filter  mask;
1800 };
1801
1802 struct ib_flow_spec_action_tag {
1803         enum ib_flow_spec_type        type;
1804         u16                           size;
1805         u32                           tag_id;
1806 };
1807
1808 union ib_flow_spec {
1809         struct {
1810                 u32                     type;
1811                 u16                     size;
1812         };
1813         struct ib_flow_spec_eth         eth;
1814         struct ib_flow_spec_ib          ib;
1815         struct ib_flow_spec_ipv4        ipv4;
1816         struct ib_flow_spec_tcp_udp     tcp_udp;
1817         struct ib_flow_spec_ipv6        ipv6;
1818         struct ib_flow_spec_tunnel      tunnel;
1819         struct ib_flow_spec_action_tag  flow_tag;
1820 };
1821
1822 struct ib_flow_attr {
1823         enum ib_flow_attr_type type;
1824         u16          size;
1825         u16          priority;
1826         u32          flags;
1827         u8           num_of_specs;
1828         u8           port;
1829         /* Following are the optional layers according to user request
1830          * struct ib_flow_spec_xxx
1831          * struct ib_flow_spec_yyy
1832          */
1833 };
1834
1835 struct ib_flow {
1836         struct ib_qp            *qp;
1837         struct ib_uobject       *uobject;
1838 };
1839
1840 struct ib_mad_hdr;
1841 struct ib_grh;
1842
1843 enum ib_process_mad_flags {
1844         IB_MAD_IGNORE_MKEY      = 1,
1845         IB_MAD_IGNORE_BKEY      = 2,
1846         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
1847 };
1848
1849 enum ib_mad_result {
1850         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
1851         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
1852         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
1853         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
1854 };
1855
1856 #define IB_DEVICE_NAME_MAX 64
1857
1858 struct ib_port_cache {
1859         struct ib_pkey_cache  *pkey;
1860         struct ib_gid_table   *gid;
1861         u8                     lmc;
1862         enum ib_port_state     port_state;
1863 };
1864
1865 struct ib_cache {
1866         rwlock_t                lock;
1867         struct ib_event_handler event_handler;
1868         struct ib_port_cache   *ports;
1869 };
1870
1871 struct iw_cm_verbs;
1872
1873 struct ib_port_immutable {
1874         int                           pkey_tbl_len;
1875         int                           gid_tbl_len;
1876         u32                           core_cap_flags;
1877         u32                           max_mad_size;
1878 };
1879
1880 struct ib_device {
1881         char                          name[IB_DEVICE_NAME_MAX];
1882
1883         struct list_head              event_handler_list;
1884         spinlock_t                    event_handler_lock;
1885
1886         spinlock_t                    client_data_lock;
1887         struct list_head              core_list;
1888         /* Access to the client_data_list is protected by the client_data_lock
1889          * spinlock and the lists_rwsem read-write semaphore */
1890         struct list_head              client_data_list;
1891
1892         struct ib_cache               cache;
1893         /**
1894          * port_immutable is indexed by port number
1895          */
1896         struct ib_port_immutable     *port_immutable;
1897
1898         int                           num_comp_vectors;
1899
1900         struct iw_cm_verbs           *iwcm;
1901
1902         /**
1903          * alloc_hw_stats - Allocate a struct rdma_hw_stats and fill in the
1904          *   driver initialized data.  The struct is kfree()'ed by the sysfs
1905          *   core when the device is removed.  A lifespan of -1 in the return
1906          *   struct tells the core to set a default lifespan.
1907          */
1908         struct rdma_hw_stats      *(*alloc_hw_stats)(struct ib_device *device,
1909                                                      u8 port_num);
1910         /**
1911          * get_hw_stats - Fill in the counter value(s) in the stats struct.
1912          * @index - The index in the value array we wish to have updated, or
1913          *   num_counters if we want all stats updated
1914          * Return codes -
1915          *   < 0 - Error, no counters updated
1916          *   index - Updated the single counter pointed to by index
1917          *   num_counters - Updated all counters (will reset the timestamp
1918          *     and prevent further calls for lifespan milliseconds)
1919          * Drivers are allowed to update all counters in leiu of just the
1920          *   one given in index at their option
1921          */
1922         int                        (*get_hw_stats)(struct ib_device *device,
1923                                                    struct rdma_hw_stats *stats,
1924                                                    u8 port, int index);
1925         int                        (*query_device)(struct ib_device *device,
1926                                                    struct ib_device_attr *device_attr,
1927                                                    struct ib_udata *udata);
1928         int                        (*query_port)(struct ib_device *device,
1929                                                  u8 port_num,
1930                                                  struct ib_port_attr *port_attr);
1931         enum rdma_link_layer       (*get_link_layer)(struct ib_device *device,
1932                                                      u8 port_num);
1933         /* When calling get_netdev, the HW vendor's driver should return the
1934          * net device of device @device at port @port_num or NULL if such
1935          * a net device doesn't exist. The vendor driver should call dev_hold
1936          * on this net device. The HW vendor's device driver must guarantee
1937          * that this function returns NULL before the net device reaches
1938          * NETDEV_UNREGISTER_FINAL state.
1939          */
1940         struct net_device         *(*get_netdev)(struct ib_device *device,
1941                                                  u8 port_num);
1942         int                        (*query_gid)(struct ib_device *device,
1943                                                 u8 port_num, int index,
1944                                                 union ib_gid *gid);
1945         /* When calling add_gid, the HW vendor's driver should
1946          * add the gid of device @device at gid index @index of
1947          * port @port_num to be @gid. Meta-info of that gid (for example,
1948          * the network device related to this gid is available
1949          * at @attr. @context allows the HW vendor driver to store extra
1950          * information together with a GID entry. The HW vendor may allocate
1951          * memory to contain this information and store it in @context when a
1952          * new GID entry is written to. Params are consistent until the next
1953          * call of add_gid or delete_gid. The function should return 0 on
1954          * success or error otherwise. The function could be called
1955          * concurrently for different ports. This function is only called
1956          * when roce_gid_table is used.
1957          */
1958         int                        (*add_gid)(struct ib_device *device,
1959                                               u8 port_num,
1960                                               unsigned int index,
1961                                               const union ib_gid *gid,
1962                                               const struct ib_gid_attr *attr,
1963                                               void **context);
1964         /* When calling del_gid, the HW vendor's driver should delete the
1965          * gid of device @device at gid index @index of port @port_num.
1966          * Upon the deletion of a GID entry, the HW vendor must free any
1967          * allocated memory. The caller will clear @context afterwards.
1968          * This function is only called when roce_gid_table is used.
1969          */
1970         int                        (*del_gid)(struct ib_device *device,
1971                                               u8 port_num,
1972                                               unsigned int index,
1973                                               void **context);
1974         int                        (*query_pkey)(struct ib_device *device,
1975                                                  u8 port_num, u16 index, u16 *pkey);
1976         int                        (*modify_device)(struct ib_device *device,
1977                                                     int device_modify_mask,
1978                                                     struct ib_device_modify *device_modify);
1979         int                        (*modify_port)(struct ib_device *device,
1980                                                   u8 port_num, int port_modify_mask,
1981                                                   struct ib_port_modify *port_modify);
1982         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
1983                                                      struct ib_udata *udata);
1984         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
1985         int                        (*mmap)(struct ib_ucontext *context,
1986                                            struct vm_area_struct *vma);
1987         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
1988                                                struct ib_ucontext *context,
1989                                                struct ib_udata *udata);
1990         int                        (*dealloc_pd)(struct ib_pd *pd);
1991         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
1992                                                 struct ib_ah_attr *ah_attr,
1993                                                 struct ib_udata *udata);
1994         int                        (*modify_ah)(struct ib_ah *ah,
1995                                                 struct ib_ah_attr *ah_attr);
1996         int                        (*query_ah)(struct ib_ah *ah,
1997                                                struct ib_ah_attr *ah_attr);
1998         int                        (*destroy_ah)(struct ib_ah *ah);
1999         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
2000                                                  struct ib_srq_init_attr *srq_init_attr,
2001                                                  struct ib_udata *udata);
2002         int                        (*modify_srq)(struct ib_srq *srq,
2003                                                  struct ib_srq_attr *srq_attr,
2004                                                  enum ib_srq_attr_mask srq_attr_mask,
2005                                                  struct ib_udata *udata);
2006         int                        (*query_srq)(struct ib_srq *srq,
2007                                                 struct ib_srq_attr *srq_attr);
2008         int                        (*destroy_srq)(struct ib_srq *srq);
2009         int                        (*post_srq_recv)(struct ib_srq *srq,
2010                                                     struct ib_recv_wr *recv_wr,
2011                                                     struct ib_recv_wr **bad_recv_wr);
2012         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
2013                                                 struct ib_qp_init_attr *qp_init_attr,
2014                                                 struct ib_udata *udata);
2015         int                        (*modify_qp)(struct ib_qp *qp,
2016                                                 struct ib_qp_attr *qp_attr,
2017                                                 int qp_attr_mask,
2018                                                 struct ib_udata *udata);
2019         int                        (*query_qp)(struct ib_qp *qp,
2020                                                struct ib_qp_attr *qp_attr,
2021                                                int qp_attr_mask,
2022                                                struct ib_qp_init_attr *qp_init_attr);
2023         int                        (*destroy_qp)(struct ib_qp *qp);
2024         int                        (*post_send)(struct ib_qp *qp,
2025                                                 struct ib_send_wr *send_wr,
2026                                                 struct ib_send_wr **bad_send_wr);
2027         int                        (*post_recv)(struct ib_qp *qp,
2028                                                 struct ib_recv_wr *recv_wr,
2029                                                 struct ib_recv_wr **bad_recv_wr);
2030         struct ib_cq *             (*create_cq)(struct ib_device *device,
2031                                                 const struct ib_cq_init_attr *attr,
2032                                                 struct ib_ucontext *context,
2033                                                 struct ib_udata *udata);
2034         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
2035                                                 u16 cq_period);
2036         int                        (*destroy_cq)(struct ib_cq *cq);
2037         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
2038                                                 struct ib_udata *udata);
2039         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
2040                                               struct ib_wc *wc);
2041         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
2042         int                        (*req_notify_cq)(struct ib_cq *cq,
2043                                                     enum ib_cq_notify_flags flags);
2044         int                        (*req_ncomp_notif)(struct ib_cq *cq,
2045                                                       int wc_cnt);
2046         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
2047                                                  int mr_access_flags);
2048         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
2049                                                   u64 start, u64 length,
2050                                                   u64 virt_addr,
2051                                                   int mr_access_flags,
2052                                                   struct ib_udata *udata);
2053         int                        (*rereg_user_mr)(struct ib_mr *mr,
2054                                                     int flags,
2055                                                     u64 start, u64 length,
2056                                                     u64 virt_addr,
2057                                                     int mr_access_flags,
2058                                                     struct ib_pd *pd,
2059                                                     struct ib_udata *udata);
2060         int                        (*dereg_mr)(struct ib_mr *mr);
2061         struct ib_mr *             (*alloc_mr)(struct ib_pd *pd,
2062                                                enum ib_mr_type mr_type,
2063                                                u32 max_num_sg);
2064         int                        (*map_mr_sg)(struct ib_mr *mr,
2065                                                 struct scatterlist *sg,
2066                                                 int sg_nents,
2067                                                 unsigned int *sg_offset);
2068         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd,
2069                                                enum ib_mw_type type,
2070                                                struct ib_udata *udata);
2071         int                        (*dealloc_mw)(struct ib_mw *mw);
2072         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
2073                                                 int mr_access_flags,
2074                                                 struct ib_fmr_attr *fmr_attr);
2075         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
2076                                                    u64 *page_list, int list_len,
2077                                                    u64 iova);
2078         int                        (*unmap_fmr)(struct list_head *fmr_list);
2079         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
2080         int                        (*attach_mcast)(struct ib_qp *qp,
2081                                                    union ib_gid *gid,
2082                                                    u16 lid);
2083         int                        (*detach_mcast)(struct ib_qp *qp,
2084                                                    union ib_gid *gid,
2085                                                    u16 lid);
2086         int                        (*process_mad)(struct ib_device *device,
2087                                                   int process_mad_flags,
2088                                                   u8 port_num,
2089                                                   const struct ib_wc *in_wc,
2090                                                   const struct ib_grh *in_grh,
2091                                                   const struct ib_mad_hdr *in_mad,
2092                                                   size_t in_mad_size,
2093                                                   struct ib_mad_hdr *out_mad,
2094                                                   size_t *out_mad_size,
2095                                                   u16 *out_mad_pkey_index);
2096         struct ib_xrcd *           (*alloc_xrcd)(struct ib_device *device,
2097                                                  struct ib_ucontext *ucontext,
2098                                                  struct ib_udata *udata);
2099         int                        (*dealloc_xrcd)(struct ib_xrcd *xrcd);
2100         struct ib_flow *           (*create_flow)(struct ib_qp *qp,
2101                                                   struct ib_flow_attr
2102                                                   *flow_attr,
2103                                                   int domain);
2104         int                        (*destroy_flow)(struct ib_flow *flow_id);
2105         int                        (*check_mr_status)(struct ib_mr *mr, u32 check_mask,
2106                                                       struct ib_mr_status *mr_status);
2107         void                       (*disassociate_ucontext)(struct ib_ucontext *ibcontext);
2108         void                       (*drain_rq)(struct ib_qp *qp);
2109         void                       (*drain_sq)(struct ib_qp *qp);
2110         int                        (*set_vf_link_state)(struct ib_device *device, int vf, u8 port,
2111                                                         int state);
2112         int                        (*get_vf_config)(struct ib_device *device, int vf, u8 port,
2113                                                    struct ifla_vf_info *ivf);
2114         int                        (*get_vf_stats)(struct ib_device *device, int vf, u8 port,
2115                                                    struct ifla_vf_stats *stats);
2116         int                        (*set_vf_guid)(struct ib_device *device, int vf, u8 port, u64 guid,
2117                                                   int type);
2118         struct ib_wq *             (*create_wq)(struct ib_pd *pd,
2119                                                 struct ib_wq_init_attr *init_attr,
2120                                                 struct ib_udata *udata);
2121         int                        (*destroy_wq)(struct ib_wq *wq);
2122         int                        (*modify_wq)(struct ib_wq *wq,
2123                                                 struct ib_wq_attr *attr,
2124                                                 u32 wq_attr_mask,
2125                                                 struct ib_udata *udata);
2126         struct ib_rwq_ind_table *  (*create_rwq_ind_table)(struct ib_device *device,
2127                                                            struct ib_rwq_ind_table_init_attr *init_attr,
2128                                                            struct ib_udata *udata);
2129         int                        (*destroy_rwq_ind_table)(struct ib_rwq_ind_table *wq_ind_table);
2130
2131         struct module               *owner;
2132         struct device                dev;
2133         struct kobject               *ports_parent;
2134         struct list_head             port_list;
2135
2136         enum {
2137                 IB_DEV_UNINITIALIZED,
2138                 IB_DEV_REGISTERED,
2139                 IB_DEV_UNREGISTERED
2140         }                            reg_state;
2141
2142         int                          uverbs_abi_ver;
2143         u64                          uverbs_cmd_mask;
2144         u64                          uverbs_ex_cmd_mask;
2145
2146         char                         node_desc[IB_DEVICE_NODE_DESC_MAX];
2147         __be64                       node_guid;
2148         u32                          local_dma_lkey;
2149         u16                          is_switch:1;
2150         u8                           node_type;
2151         u8                           phys_port_cnt;
2152         struct ib_device_attr        attrs;
2153         struct attribute_group       *hw_stats_ag;
2154         struct rdma_hw_stats         *hw_stats;
2155
2156 #ifdef CONFIG_CGROUP_RDMA
2157         struct rdmacg_device         cg_device;
2158 #endif
2159
2160         /**
2161          * The following mandatory functions are used only at device
2162          * registration.  Keep functions such as these at the end of this
2163          * structure to avoid cache line misses when accessing struct ib_device
2164          * in fast paths.
2165          */
2166         int (*get_port_immutable)(struct ib_device *, u8, struct ib_port_immutable *);
2167         void (*get_dev_fw_str)(struct ib_device *, char *str, size_t str_len);
2168 };
2169
2170 struct ib_client {
2171         char  *name;
2172         void (*add)   (struct ib_device *);
2173         void (*remove)(struct ib_device *, void *client_data);
2174
2175         /* Returns the net_dev belonging to this ib_client and matching the
2176          * given parameters.
2177          * @dev:         An RDMA device that the net_dev use for communication.
2178          * @port:        A physical port number on the RDMA device.
2179          * @pkey:        P_Key that the net_dev uses if applicable.
2180          * @gid:         A GID that the net_dev uses to communicate.
2181          * @addr:        An IP address the net_dev is configured with.
2182          * @client_data: The device's client data set by ib_set_client_data().
2183          *
2184          * An ib_client that implements a net_dev on top of RDMA devices
2185          * (such as IP over IB) should implement this callback, allowing the
2186          * rdma_cm module to find the right net_dev for a given request.
2187          *
2188          * The caller is responsible for calling dev_put on the returned
2189          * netdev. */
2190         struct net_device *(*get_net_dev_by_params)(
2191                         struct ib_device *dev,
2192                         u8 port,
2193                         u16 pkey,
2194                         const union ib_gid *gid,
2195                         const struct sockaddr *addr,
2196                         void *client_data);
2197         struct list_head list;
2198 };
2199
2200 struct ib_device *ib_alloc_device(size_t size);
2201 void ib_dealloc_device(struct ib_device *device);
2202
2203 void ib_get_device_fw_str(struct ib_device *device, char *str, size_t str_len);
2204
2205 int ib_register_device(struct ib_device *device,
2206                        int (*port_callback)(struct ib_device *,
2207                                             u8, struct kobject *));
2208 void ib_unregister_device(struct ib_device *device);
2209
2210 int ib_register_client   (struct ib_client *client);
2211 void ib_unregister_client(struct ib_client *client);
2212
2213 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
2214 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
2215                          void *data);
2216
2217 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
2218 {
2219         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
2220 }
2221
2222 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
2223 {
2224         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
2225 }
2226
2227 static inline bool ib_is_udata_cleared(struct ib_udata *udata,
2228                                        size_t offset,
2229                                        size_t len)
2230 {
2231         const void __user *p = udata->inbuf + offset;
2232         bool ret;
2233         u8 *buf;
2234
2235         if (len > USHRT_MAX)
2236                 return false;
2237
2238         buf = memdup_user(p, len);
2239         if (IS_ERR(buf))
2240                 return false;
2241
2242         ret = !memchr_inv(buf, 0, len);
2243         kfree(buf);
2244         return ret;
2245 }
2246
2247 /**
2248  * ib_modify_qp_is_ok - Check that the supplied attribute mask
2249  * contains all required attributes and no attributes not allowed for
2250  * the given QP state transition.
2251  * @cur_state: Current QP state
2252  * @next_state: Next QP state
2253  * @type: QP type
2254  * @mask: Mask of supplied QP attributes
2255  * @ll : link layer of port
2256  *
2257  * This function is a helper function that a low-level driver's
2258  * modify_qp method can use to validate the consumer's input.  It
2259  * checks that cur_state and next_state are valid QP states, that a
2260  * transition from cur_state to next_state is allowed by the IB spec,
2261  * and that the attribute mask supplied is allowed for the transition.
2262  */
2263 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
2264                        enum ib_qp_type type, enum ib_qp_attr_mask mask,
2265                        enum rdma_link_layer ll);
2266
2267 int ib_register_event_handler  (struct ib_event_handler *event_handler);
2268 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
2269 void ib_dispatch_event(struct ib_event *event);
2270
2271 int ib_query_port(struct ib_device *device,
2272                   u8 port_num, struct ib_port_attr *port_attr);
2273
2274 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
2275                                                u8 port_num);
2276
2277 /**
2278  * rdma_cap_ib_switch - Check if the device is IB switch
2279  * @device: Device to check
2280  *
2281  * Device driver is responsible for setting is_switch bit on
2282  * in ib_device structure at init time.
2283  *
2284  * Return: true if the device is IB switch.
2285  */
2286 static inline bool rdma_cap_ib_switch(const struct ib_device *device)
2287 {
2288         return device->is_switch;
2289 }
2290
2291 /**
2292  * rdma_start_port - Return the first valid port number for the device
2293  * specified
2294  *
2295  * @device: Device to be checked
2296  *
2297  * Return start port number
2298  */
2299 static inline u8 rdma_start_port(const struct ib_device *device)
2300 {
2301         return rdma_cap_ib_switch(device) ? 0 : 1;
2302 }
2303
2304 /**
2305  * rdma_end_port - Return the last valid port number for the device
2306  * specified
2307  *
2308  * @device: Device to be checked
2309  *
2310  * Return last port number
2311  */
2312 static inline u8 rdma_end_port(const struct ib_device *device)
2313 {
2314         return rdma_cap_ib_switch(device) ? 0 : device->phys_port_cnt;
2315 }
2316
2317 static inline int rdma_is_port_valid(const struct ib_device *device,
2318                                      unsigned int port)
2319 {
2320         return (port >= rdma_start_port(device) &&
2321                 port <= rdma_end_port(device));
2322 }
2323
2324 static inline bool rdma_protocol_ib(const struct ib_device *device, u8 port_num)
2325 {
2326         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_IB;
2327 }
2328
2329 static inline bool rdma_protocol_roce(const struct ib_device *device, u8 port_num)
2330 {
2331         return device->port_immutable[port_num].core_cap_flags &
2332                 (RDMA_CORE_CAP_PROT_ROCE | RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP);
2333 }
2334
2335 static inline bool rdma_protocol_roce_udp_encap(const struct ib_device *device, u8 port_num)
2336 {
2337         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP;
2338 }
2339
2340 static inline bool rdma_protocol_roce_eth_encap(const struct ib_device *device, u8 port_num)
2341 {
2342         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_ROCE;
2343 }
2344
2345 static inline bool rdma_protocol_iwarp(const struct ib_device *device, u8 port_num)
2346 {
2347         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_IWARP;
2348 }
2349
2350 static inline bool rdma_ib_or_roce(const struct ib_device *device, u8 port_num)
2351 {
2352         return rdma_protocol_ib(device, port_num) ||
2353                 rdma_protocol_roce(device, port_num);
2354 }
2355
2356 static inline bool rdma_protocol_raw_packet(const struct ib_device *device, u8 port_num)
2357 {
2358         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_RAW_PACKET;
2359 }
2360
2361 static inline bool rdma_protocol_usnic(const struct ib_device *device, u8 port_num)
2362 {
2363         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_USNIC;
2364 }
2365
2366 /**
2367  * rdma_cap_ib_mad - Check if the port of a device supports Infiniband
2368  * Management Datagrams.
2369  * @device: Device to check
2370  * @port_num: Port number to check
2371  *
2372  * Management Datagrams (MAD) are a required part of the InfiniBand
2373  * specification and are supported on all InfiniBand devices.  A slightly
2374  * extended version are also supported on OPA interfaces.
2375  *
2376  * Return: true if the port supports sending/receiving of MAD packets.
2377  */
2378 static inline bool rdma_cap_ib_mad(const struct ib_device *device, u8 port_num)
2379 {
2380         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_MAD;
2381 }
2382
2383 /**
2384  * rdma_cap_opa_mad - Check if the port of device provides support for OPA
2385  * Management Datagrams.
2386  * @device: Device to check
2387  * @port_num: Port number to check
2388  *
2389  * Intel OmniPath devices extend and/or replace the InfiniBand Management
2390  * datagrams with their own versions.  These OPA MADs share many but not all of
2391  * the characteristics of InfiniBand MADs.
2392  *
2393  * OPA MADs differ in the following ways:
2394  *
2395  *    1) MADs are variable size up to 2K
2396  *       IBTA defined MADs remain fixed at 256 bytes
2397  *    2) OPA SMPs must carry valid PKeys
2398  *    3) OPA SMP packets are a different format
2399  *
2400  * Return: true if the port supports OPA MAD packet formats.
2401  */
2402 static inline bool rdma_cap_opa_mad(struct ib_device *device, u8 port_num)
2403 {
2404         return (device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_OPA_MAD)
2405                 == RDMA_CORE_CAP_OPA_MAD;
2406 }
2407
2408 /**
2409  * rdma_cap_ib_smi - Check if the port of a device provides an Infiniband
2410  * Subnet Management Agent (SMA) on the Subnet Management Interface (SMI).
2411  * @device: Device to check
2412  * @port_num: Port number to check
2413  *
2414  * Each InfiniBand node is required to provide a Subnet Management Agent
2415  * that the subnet manager can access.  Prior to the fabric being fully
2416  * configured by the subnet manager, the SMA is accessed via a well known
2417  * interface called the Subnet Management Interface (SMI).  This interface
2418  * uses directed route packets to communicate with the SM to get around the
2419  * chicken and egg problem of the SM needing to know what's on the fabric
2420  * in order to configure the fabric, and needing to configure the fabric in
2421  * order to send packets to the devices on the fabric.  These directed
2422  * route packets do not need the fabric fully configured in order to reach
2423  * their destination.  The SMI is the only method allowed to send
2424  * directed route packets on an InfiniBand fabric.
2425  *
2426  * Return: true if the port provides an SMI.
2427  */
2428 static inline bool rdma_cap_ib_smi(const struct ib_device *device, u8 port_num)
2429 {
2430         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_SMI;
2431 }
2432
2433 /**
2434  * rdma_cap_ib_cm - Check if the port of device has the capability Infiniband
2435  * Communication Manager.
2436  * @device: Device to check
2437  * @port_num: Port number to check
2438  *
2439  * The InfiniBand Communication Manager is one of many pre-defined General
2440  * Service Agents (GSA) that are accessed via the General Service
2441  * Interface (GSI).  It's role is to facilitate establishment of connections
2442  * between nodes as well as other management related tasks for established
2443  * connections.
2444  *
2445  * Return: true if the port supports an IB CM (this does not guarantee that
2446  * a CM is actually running however).
2447  */
2448 static inline bool rdma_cap_ib_cm(const struct ib_device *device, u8 port_num)
2449 {
2450         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_CM;
2451 }
2452
2453 /**
2454  * rdma_cap_iw_cm - Check if the port of device has the capability IWARP
2455  * Communication Manager.
2456  * @device: Device to check
2457  * @port_num: Port number to check
2458  *
2459  * Similar to above, but specific to iWARP connections which have a different
2460  * managment protocol than InfiniBand.
2461  *
2462  * Return: true if the port supports an iWARP CM (this does not guarantee that
2463  * a CM is actually running however).
2464  */
2465 static inline bool rdma_cap_iw_cm(const struct ib_device *device, u8 port_num)
2466 {
2467         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IW_CM;
2468 }
2469
2470 /**
2471  * rdma_cap_ib_sa - Check if the port of device has the capability Infiniband
2472  * Subnet Administration.
2473  * @device: Device to check
2474  * @port_num: Port number to check
2475  *
2476  * An InfiniBand Subnet Administration (SA) service is a pre-defined General
2477  * Service Agent (GSA) provided by the Subnet Manager (SM).  On InfiniBand
2478  * fabrics, devices should resolve routes to other hosts by contacting the
2479  * SA to query the proper route.
2480  *
2481  * Return: true if the port should act as a client to the fabric Subnet
2482  * Administration interface.  This does not imply that the SA service is
2483  * running locally.
2484  */
2485 static inline bool rdma_cap_ib_sa(const struct ib_device *device, u8 port_num)
2486 {
2487         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_SA;
2488 }
2489
2490 /**
2491  * rdma_cap_ib_mcast - Check if the port of device has the capability Infiniband
2492  * Multicast.
2493  * @device: Device to check
2494  * @port_num: Port number to check
2495  *
2496  * InfiniBand multicast registration is more complex than normal IPv4 or
2497  * IPv6 multicast registration.  Each Host Channel Adapter must register
2498  * with the Subnet Manager when it wishes to join a multicast group.  It
2499  * should do so only once regardless of how many queue pairs it subscribes
2500  * to this group.  And it should leave the group only after all queue pairs
2501  * attached to the group have been detached.
2502  *
2503  * Return: true if the port must undertake the additional adminstrative
2504  * overhead of registering/unregistering with the SM and tracking of the
2505  * total number of queue pairs attached to the multicast group.
2506  */
2507 static inline bool rdma_cap_ib_mcast(const struct ib_device *device, u8 port_num)
2508 {
2509         return rdma_cap_ib_sa(device, port_num);
2510 }
2511
2512 /**
2513  * rdma_cap_af_ib - Check if the port of device has the capability
2514  * Native Infiniband Address.
2515  * @device: Device to check
2516  * @port_num: Port number to check
2517  *
2518  * InfiniBand addressing uses a port's GUID + Subnet Prefix to make a default
2519  * GID.  RoCE uses a different mechanism, but still generates a GID via
2520  * a prescribed mechanism and port specific data.
2521  *
2522  * Return: true if the port uses a GID address to identify devices on the
2523  * network.
2524  */
2525 static inline bool rdma_cap_af_ib(const struct ib_device *device, u8 port_num)
2526 {
2527         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_AF_IB;
2528 }
2529
2530 /**
2531  * rdma_cap_eth_ah - Check if the port of device has the capability
2532  * Ethernet Address Handle.
2533  * @device: Device to check
2534  * @port_num: Port number to check
2535  *
2536  * RoCE is InfiniBand over Ethernet, and it uses a well defined technique
2537  * to fabricate GIDs over Ethernet/IP specific addresses native to the
2538  * port.  Normally, packet headers are generated by the sending host
2539  * adapter, but when sending connectionless datagrams, we must manually
2540  * inject the proper headers for the fabric we are communicating over.
2541  *
2542  * Return: true if we are running as a RoCE port and must force the
2543  * addition of a Global Route Header built from our Ethernet Address
2544  * Handle into our header list for connectionless packets.
2545  */
2546 static inline bool rdma_cap_eth_ah(const struct ib_device *device, u8 port_num)
2547 {
2548         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_ETH_AH;
2549 }
2550
2551 /**
2552  * rdma_max_mad_size - Return the max MAD size required by this RDMA Port.
2553  *
2554  * @device: Device
2555  * @port_num: Port number
2556  *
2557  * This MAD size includes the MAD headers and MAD payload.  No other headers
2558  * are included.
2559  *
2560  * Return the max MAD size required by the Port.  Will return 0 if the port
2561  * does not support MADs
2562  */
2563 static inline size_t rdma_max_mad_size(const struct ib_device *device, u8 port_num)
2564 {
2565         return device->port_immutable[port_num].max_mad_size;
2566 }
2567
2568 /**
2569  * rdma_cap_roce_gid_table - Check if the port of device uses roce_gid_table
2570  * @device: Device to check
2571  * @port_num: Port number to check
2572  *
2573  * RoCE GID table mechanism manages the various GIDs for a device.
2574  *
2575  * NOTE: if allocating the port's GID table has failed, this call will still
2576  * return true, but any RoCE GID table API will fail.
2577  *
2578  * Return: true if the port uses RoCE GID table mechanism in order to manage
2579  * its GIDs.
2580  */
2581 static inline bool rdma_cap_roce_gid_table(const struct ib_device *device,
2582                                            u8 port_num)
2583 {
2584         return rdma_protocol_roce(device, port_num) &&
2585                 device->add_gid && device->del_gid;
2586 }
2587
2588 /*
2589  * Check if the device supports READ W/ INVALIDATE.
2590  */
2591 static inline bool rdma_cap_read_inv(struct ib_device *dev, u32 port_num)
2592 {
2593         /*
2594          * iWarp drivers must support READ W/ INVALIDATE.  No other protocol
2595          * has support for it yet.
2596          */
2597         return rdma_protocol_iwarp(dev, port_num);
2598 }
2599
2600 int ib_query_gid(struct ib_device *device,
2601                  u8 port_num, int index, union ib_gid *gid,
2602                  struct ib_gid_attr *attr);
2603
2604 int ib_set_vf_link_state(struct ib_device *device, int vf, u8 port,
2605                          int state);
2606 int ib_get_vf_config(struct ib_device *device, int vf, u8 port,
2607                      struct ifla_vf_info *info);
2608 int ib_get_vf_stats(struct ib_device *device, int vf, u8 port,
2609                     struct ifla_vf_stats *stats);
2610 int ib_set_vf_guid(struct ib_device *device, int vf, u8 port, u64 guid,
2611                    int type);
2612
2613 int ib_query_pkey(struct ib_device *device,
2614                   u8 port_num, u16 index, u16 *pkey);
2615
2616 int ib_modify_device(struct ib_device *device,
2617                      int device_modify_mask,
2618                      struct ib_device_modify *device_modify);
2619
2620 int ib_modify_port(struct ib_device *device,
2621                    u8 port_num, int port_modify_mask,
2622                    struct ib_port_modify *port_modify);
2623
2624 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
2625                 enum ib_gid_type gid_type, struct net_device *ndev,
2626                 u8 *port_num, u16 *index);
2627
2628 int ib_find_pkey(struct ib_device *device,
2629                  u8 port_num, u16 pkey, u16 *index);
2630
2631 enum ib_pd_flags {
2632         /*
2633          * Create a memory registration for all memory in the system and place
2634          * the rkey for it into pd->unsafe_global_rkey.  This can be used by
2635          * ULPs to avoid the overhead of dynamic MRs.
2636          *
2637          * This flag is generally considered unsafe and must only be used in
2638          * extremly trusted environments.  Every use of it will log a warning
2639          * in the kernel log.
2640          */
2641         IB_PD_UNSAFE_GLOBAL_RKEY        = 0x01,
2642 };
2643
2644 struct ib_pd *__ib_alloc_pd(struct ib_device *device, unsigned int flags,
2645                 const char *caller);
2646 #define ib_alloc_pd(device, flags) \
2647         __ib_alloc_pd((device), (flags), __func__)
2648 void ib_dealloc_pd(struct ib_pd *pd);
2649
2650 /**
2651  * ib_create_ah - Creates an address handle for the given address vector.
2652  * @pd: The protection domain associated with the address handle.
2653  * @ah_attr: The attributes of the address vector.
2654  *
2655  * The address handle is used to reference a local or global destination
2656  * in all UD QP post sends.
2657  */
2658 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
2659
2660 /**
2661  * ib_get_gids_from_rdma_hdr - Get sgid and dgid from GRH or IPv4 header
2662  *   work completion.
2663  * @hdr: the L3 header to parse
2664  * @net_type: type of header to parse
2665  * @sgid: place to store source gid
2666  * @dgid: place to store destination gid
2667  */
2668 int ib_get_gids_from_rdma_hdr(const union rdma_network_hdr *hdr,
2669                               enum rdma_network_type net_type,
2670                               union ib_gid *sgid, union ib_gid *dgid);
2671
2672 /**
2673  * ib_get_rdma_header_version - Get the header version
2674  * @hdr: the L3 header to parse
2675  */
2676 int ib_get_rdma_header_version(const union rdma_network_hdr *hdr);
2677
2678 /**
2679  * ib_init_ah_from_wc - Initializes address handle attributes from a
2680  *   work completion.
2681  * @device: Device on which the received message arrived.
2682  * @port_num: Port on which the received message arrived.
2683  * @wc: Work completion associated with the received message.
2684  * @grh: References the received global route header.  This parameter is
2685  *   ignored unless the work completion indicates that the GRH is valid.
2686  * @ah_attr: Returned attributes that can be used when creating an address
2687  *   handle for replying to the message.
2688  */
2689 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num,
2690                        const struct ib_wc *wc, const struct ib_grh *grh,
2691                        struct ib_ah_attr *ah_attr);
2692
2693 /**
2694  * ib_create_ah_from_wc - Creates an address handle associated with the
2695  *   sender of the specified work completion.
2696  * @pd: The protection domain associated with the address handle.
2697  * @wc: Work completion information associated with a received message.
2698  * @grh: References the received global route header.  This parameter is
2699  *   ignored unless the work completion indicates that the GRH is valid.
2700  * @port_num: The outbound port number to associate with the address.
2701  *
2702  * The address handle is used to reference a local or global destination
2703  * in all UD QP post sends.
2704  */
2705 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, const struct ib_wc *wc,
2706                                    const struct ib_grh *grh, u8 port_num);
2707
2708 /**
2709  * ib_modify_ah - Modifies the address vector associated with an address
2710  *   handle.
2711  * @ah: The address handle to modify.
2712  * @ah_attr: The new address vector attributes to associate with the
2713  *   address handle.
2714  */
2715 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
2716
2717 /**
2718  * ib_query_ah - Queries the address vector associated with an address
2719  *   handle.
2720  * @ah: The address handle to query.
2721  * @ah_attr: The address vector attributes associated with the address
2722  *   handle.
2723  */
2724 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
2725
2726 /**
2727  * ib_destroy_ah - Destroys an address handle.
2728  * @ah: The address handle to destroy.
2729  */
2730 int ib_destroy_ah(struct ib_ah *ah);
2731
2732 /**
2733  * ib_create_srq - Creates a SRQ associated with the specified protection
2734  *   domain.
2735  * @pd: The protection domain associated with the SRQ.
2736  * @srq_init_attr: A list of initial attributes required to create the
2737  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
2738  *   the actual capabilities of the created SRQ.
2739  *
2740  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
2741  * requested size of the SRQ, and set to the actual values allocated
2742  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
2743  * will always be at least as large as the requested values.
2744  */
2745 struct ib_srq *ib_create_srq(struct ib_pd *pd,
2746                              struct ib_srq_init_attr *srq_init_attr);
2747
2748 /**
2749  * ib_modify_srq - Modifies the attributes for the specified SRQ.
2750  * @srq: The SRQ to modify.
2751  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
2752  *   the current values of selected SRQ attributes are returned.
2753  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
2754  *   are being modified.
2755  *
2756  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
2757  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
2758  * the number of receives queued drops below the limit.
2759  */
2760 int ib_modify_srq(struct ib_srq *srq,
2761                   struct ib_srq_attr *srq_attr,
2762                   enum ib_srq_attr_mask srq_attr_mask);
2763
2764 /**
2765  * ib_query_srq - Returns the attribute list and current values for the
2766  *   specified SRQ.
2767  * @srq: The SRQ to query.
2768  * @srq_attr: The attributes of the specified SRQ.
2769  */
2770 int ib_query_srq(struct ib_srq *srq,
2771                  struct ib_srq_attr *srq_attr);
2772
2773 /**
2774  * ib_destroy_srq - Destroys the specified SRQ.
2775  * @srq: The SRQ to destroy.
2776  */
2777 int ib_destroy_srq(struct ib_srq *srq);
2778
2779 /**
2780  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
2781  * @srq: The SRQ to post the work request on.
2782  * @recv_wr: A list of work requests to post on the receive queue.
2783  * @bad_recv_wr: On an immediate failure, this parameter will reference
2784  *   the work request that failed to be posted on the QP.
2785  */
2786 static inline int ib_post_srq_recv(struct ib_srq *srq,
2787                                    struct ib_recv_wr *recv_wr,
2788                                    struct ib_recv_wr **bad_recv_wr)
2789 {
2790         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
2791 }
2792
2793 /**
2794  * ib_create_qp - Creates a QP associated with the specified protection
2795  *   domain.
2796  * @pd: The protection domain associated with the QP.
2797  * @qp_init_attr: A list of initial attributes required to create the
2798  *   QP.  If QP creation succeeds, then the attributes are updated to
2799  *   the actual capabilities of the created QP.
2800  */
2801 struct ib_qp *ib_create_qp(struct ib_pd *pd,
2802                            struct ib_qp_init_attr *qp_init_attr);
2803
2804 /**
2805  * ib_modify_qp - Modifies the attributes for the specified QP and then
2806  *   transitions the QP to the given state.
2807  * @qp: The QP to modify.
2808  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
2809  *   the current values of selected QP attributes are returned.
2810  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
2811  *   are being modified.
2812  */
2813 int ib_modify_qp(struct ib_qp *qp,
2814                  struct ib_qp_attr *qp_attr,
2815                  int qp_attr_mask);
2816
2817 /**
2818  * ib_query_qp - Returns the attribute list and current values for the
2819  *   specified QP.
2820  * @qp: The QP to query.
2821  * @qp_attr: The attributes of the specified QP.
2822  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
2823  * @qp_init_attr: Additional attributes of the selected QP.
2824  *
2825  * The qp_attr_mask may be used to limit the query to gathering only the
2826  * selected attributes.
2827  */
2828 int ib_query_qp(struct ib_qp *qp,
2829                 struct ib_qp_attr *qp_attr,
2830                 int qp_attr_mask,
2831                 struct ib_qp_init_attr *qp_init_attr);
2832
2833 /**
2834  * ib_destroy_qp - Destroys the specified QP.
2835  * @qp: The QP to destroy.
2836  */
2837 int ib_destroy_qp(struct ib_qp *qp);
2838
2839 /**
2840  * ib_open_qp - Obtain a reference to an existing sharable QP.
2841  * @xrcd - XRC domain
2842  * @qp_open_attr: Attributes identifying the QP to open.
2843  *
2844  * Returns a reference to a sharable QP.
2845  */
2846 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
2847                          struct ib_qp_open_attr *qp_open_attr);
2848
2849 /**
2850  * ib_close_qp - Release an external reference to a QP.
2851  * @qp: The QP handle to release
2852  *
2853  * The opened QP handle is released by the caller.  The underlying
2854  * shared QP is not destroyed until all internal references are released.
2855  */
2856 int ib_close_qp(struct ib_qp *qp);
2857
2858 /**
2859  * ib_post_send - Posts a list of work requests to the send queue of
2860  *   the specified QP.
2861  * @qp: The QP to post the work request on.
2862  * @send_wr: A list of work requests to post on the send queue.
2863  * @bad_send_wr: On an immediate failure, this parameter will reference
2864  *   the work request that failed to be posted on the QP.
2865  *
2866  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
2867  * error is returned, the QP state shall not be affected,
2868  * ib_post_send() will return an immediate error after queueing any
2869  * earlier work requests in the list.
2870  */
2871 static inline int ib_post_send(struct ib_qp *qp,
2872                                struct ib_send_wr *send_wr,
2873                                struct ib_send_wr **bad_send_wr)
2874 {
2875         return qp->device->post_send(qp, send_wr, bad_send_wr);
2876 }
2877
2878 /**
2879  * ib_post_recv - Posts a list of work requests to the receive queue of
2880  *   the specified QP.
2881  * @qp: The QP to post the work request on.
2882  * @recv_wr: A list of work requests to post on the receive queue.
2883  * @bad_recv_wr: On an immediate failure, this parameter will reference
2884  *   the work request that failed to be posted on the QP.
2885  */
2886 static inline int ib_post_recv(struct ib_qp *qp,
2887                                struct ib_recv_wr *recv_wr,
2888                                struct ib_recv_wr **bad_recv_wr)
2889 {
2890         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
2891 }
2892
2893 struct ib_cq *ib_alloc_cq(struct ib_device *dev, void *private,
2894                 int nr_cqe, int comp_vector, enum ib_poll_context poll_ctx);
2895 void ib_free_cq(struct ib_cq *cq);
2896 int ib_process_cq_direct(struct ib_cq *cq, int budget);
2897
2898 /**
2899  * ib_create_cq - Creates a CQ on the specified device.
2900  * @device: The device on which to create the CQ.
2901  * @comp_handler: A user-specified callback that is invoked when a
2902  *   completion event occurs on the CQ.
2903  * @event_handler: A user-specified callback that is invoked when an
2904  *   asynchronous event not associated with a completion occurs on the CQ.
2905  * @cq_context: Context associated with the CQ returned to the user via
2906  *   the associated completion and event handlers.
2907  * @cq_attr: The attributes the CQ should be created upon.
2908  *
2909  * Users can examine the cq structure to determine the actual CQ size.
2910  */
2911 struct ib_cq *ib_create_cq(struct ib_device *device,
2912                            ib_comp_handler comp_handler,
2913                            void (*event_handler)(struct ib_event *, void *),
2914                            void *cq_context,
2915                            const struct ib_cq_init_attr *cq_attr);
2916
2917 /**
2918  * ib_resize_cq - Modifies the capacity of the CQ.
2919  * @cq: The CQ to resize.
2920  * @cqe: The minimum size of the CQ.
2921  *
2922  * Users can examine the cq structure to determine the actual CQ size.
2923  */
2924 int ib_resize_cq(struct ib_cq *cq, int cqe);
2925
2926 /**
2927  * ib_modify_cq - Modifies moderation params of the CQ
2928  * @cq: The CQ to modify.
2929  * @cq_count: number of CQEs that will trigger an event
2930  * @cq_period: max period of time in usec before triggering an event
2931  *
2932  */
2933 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
2934
2935 /**
2936  * ib_destroy_cq - Destroys the specified CQ.
2937  * @cq: The CQ to destroy.
2938  */
2939 int ib_destroy_cq(struct ib_cq *cq);
2940
2941 /**
2942  * ib_poll_cq - poll a CQ for completion(s)
2943  * @cq:the CQ being polled
2944  * @num_entries:maximum number of completions to return
2945  * @wc:array of at least @num_entries &struct ib_wc where completions
2946  *   will be returned
2947  *
2948  * Poll a CQ for (possibly multiple) completions.  If the return value
2949  * is < 0, an error occurred.  If the return value is >= 0, it is the
2950  * number of completions returned.  If the return value is
2951  * non-negative and < num_entries, then the CQ was emptied.
2952  */
2953 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
2954                              struct ib_wc *wc)
2955 {
2956         return cq->device->poll_cq(cq, num_entries, wc);
2957 }
2958
2959 /**
2960  * ib_peek_cq - Returns the number of unreaped completions currently
2961  *   on the specified CQ.
2962  * @cq: The CQ to peek.
2963  * @wc_cnt: A minimum number of unreaped completions to check for.
2964  *
2965  * If the number of unreaped completions is greater than or equal to wc_cnt,
2966  * this function returns wc_cnt, otherwise, it returns the actual number of
2967  * unreaped completions.
2968  */
2969 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
2970
2971 /**
2972  * ib_req_notify_cq - Request completion notification on a CQ.
2973  * @cq: The CQ to generate an event for.
2974  * @flags:
2975  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
2976  *   to request an event on the next solicited event or next work
2977  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
2978  *   may also be |ed in to request a hint about missed events, as
2979  *   described below.
2980  *
2981  * Return Value:
2982  *    < 0 means an error occurred while requesting notification
2983  *   == 0 means notification was requested successfully, and if
2984  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
2985  *        were missed and it is safe to wait for another event.  In
2986  *        this case is it guaranteed that any work completions added
2987  *        to the CQ since the last CQ poll will trigger a completion
2988  *        notification event.
2989  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
2990  *        in.  It means that the consumer must poll the CQ again to
2991  *        make sure it is empty to avoid missing an event because of a
2992  *        race between requesting notification and an entry being
2993  *        added to the CQ.  This return value means it is possible
2994  *        (but not guaranteed) that a work completion has been added
2995  *        to the CQ since the last poll without triggering a
2996  *        completion notification event.
2997  */
2998 static inline int ib_req_notify_cq(struct ib_cq *cq,
2999                                    enum ib_cq_notify_flags flags)
3000 {
3001         return cq->device->req_notify_cq(cq, flags);
3002 }
3003
3004 /**
3005  * ib_req_ncomp_notif - Request completion notification when there are
3006  *   at least the specified number of unreaped completions on the CQ.
3007  * @cq: The CQ to generate an event for.
3008  * @wc_cnt: The number of unreaped completions that should be on the
3009  *   CQ before an event is generated.
3010  */
3011 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
3012 {
3013         return cq->device->req_ncomp_notif ?
3014                 cq->device->req_ncomp_notif(cq, wc_cnt) :
3015                 -ENOSYS;
3016 }
3017
3018 /**
3019  * ib_dma_mapping_error - check a DMA addr for error
3020  * @dev: The device for which the dma_addr was created
3021  * @dma_addr: The DMA address to check
3022  */
3023 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
3024 {
3025         return dma_mapping_error(&dev->dev, dma_addr);
3026 }
3027
3028 /**
3029  * ib_dma_map_single - Map a kernel virtual address to DMA address
3030  * @dev: The device for which the dma_addr is to be created
3031  * @cpu_addr: The kernel virtual address
3032  * @size: The size of the region in bytes
3033  * @direction: The direction of the DMA
3034  */
3035 static inline u64 ib_dma_map_single(struct ib_device *dev,
3036                                     void *cpu_addr, size_t size,
3037                                     enum dma_data_direction direction)
3038 {
3039         return dma_map_single(&dev->dev, cpu_addr, size, direction);
3040 }
3041
3042 /**
3043  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
3044  * @dev: The device for which the DMA address was created
3045  * @addr: The DMA address
3046  * @size: The size of the region in bytes
3047  * @direction: The direction of the DMA
3048  */
3049 static inline void ib_dma_unmap_single(struct ib_device *dev,
3050                                        u64 addr, size_t size,
3051                                        enum dma_data_direction direction)
3052 {
3053         dma_unmap_single(&dev->dev, addr, size, direction);
3054 }
3055
3056 /**
3057  * ib_dma_map_page - Map a physical page to DMA address
3058  * @dev: The device for which the dma_addr is to be created
3059  * @page: The page to be mapped
3060  * @offset: The offset within the page
3061  * @size: The size of the region in bytes
3062  * @direction: The direction of the DMA
3063  */
3064 static inline u64 ib_dma_map_page(struct ib_device *dev,
3065                                   struct page *page,
3066                                   unsigned long offset,
3067                                   size_t size,
3068                                          enum dma_data_direction direction)
3069 {
3070         return dma_map_page(&dev->dev, page, offset, size, direction);
3071 }
3072
3073 /**
3074  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
3075  * @dev: The device for which the DMA address was created
3076  * @addr: The DMA address
3077  * @size: The size of the region in bytes
3078  * @direction: The direction of the DMA
3079  */
3080 static inline void ib_dma_unmap_page(struct ib_device *dev,
3081                                      u64 addr, size_t size,
3082                                      enum dma_data_direction direction)
3083 {
3084         dma_unmap_page(&dev->dev, addr, size, direction);
3085 }
3086
3087 /**
3088  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
3089  * @dev: The device for which the DMA addresses are to be created
3090  * @sg: The array of scatter/gather entries
3091  * @nents: The number of scatter/gather entries
3092  * @direction: The direction of the DMA
3093  */
3094 static inline int ib_dma_map_sg(struct ib_device *dev,
3095                                 struct scatterlist *sg, int nents,
3096                                 enum dma_data_direction direction)
3097 {
3098         return dma_map_sg(&dev->dev, sg, nents, direction);
3099 }
3100
3101 /**
3102  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
3103  * @dev: The device for which the DMA addresses were created
3104  * @sg: The array of scatter/gather entries
3105  * @nents: The number of scatter/gather entries
3106  * @direction: The direction of the DMA
3107  */
3108 static inline void ib_dma_unmap_sg(struct ib_device *dev,
3109                                    struct scatterlist *sg, int nents,
3110                                    enum dma_data_direction direction)
3111 {
3112         dma_unmap_sg(&dev->dev, sg, nents, direction);
3113 }
3114
3115 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
3116                                       struct scatterlist *sg, int nents,
3117                                       enum dma_data_direction direction,
3118                                       unsigned long dma_attrs)
3119 {
3120         return dma_map_sg_attrs(&dev->dev, sg, nents, direction, dma_attrs);
3121 }
3122
3123 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
3124                                          struct scatterlist *sg, int nents,
3125                                          enum dma_data_direction direction,
3126                                          unsigned long dma_attrs)
3127 {
3128         dma_unmap_sg_attrs(&dev->dev, sg, nents, direction, dma_attrs);
3129 }
3130 /**
3131  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
3132  * @dev: The device for which the DMA addresses were created
3133  * @sg: The scatter/gather entry
3134  *
3135  * Note: this function is obsolete. To do: change all occurrences of
3136  * ib_sg_dma_address() into sg_dma_address().
3137  */
3138 static inline u64 ib_sg_dma_address(struct ib_device *dev,
3139                                     struct scatterlist *sg)
3140 {
3141         return sg_dma_address(sg);
3142 }
3143
3144 /**
3145  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
3146  * @dev: The device for which the DMA addresses were created
3147  * @sg: The scatter/gather entry
3148  *
3149  * Note: this function is obsolete. To do: change all occurrences of
3150  * ib_sg_dma_len() into sg_dma_len().
3151  */
3152 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
3153                                          struct scatterlist *sg)
3154 {
3155         return sg_dma_len(sg);
3156 }
3157
3158 /**
3159  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
3160  * @dev: The device for which the DMA address was created
3161  * @addr: The DMA address
3162  * @size: The size of the region in bytes
3163  * @dir: The direction of the DMA
3164  */
3165 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
3166                                               u64 addr,
3167                                               size_t size,
3168                                               enum dma_data_direction dir)
3169 {
3170         dma_sync_single_for_cpu(&dev->dev, addr, size, dir);
3171 }
3172
3173 /**
3174  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
3175  * @dev: The device for which the DMA address was created
3176  * @addr: The DMA address
3177  * @size: The size of the region in bytes
3178  * @dir: The direction of the DMA
3179  */
3180 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
3181                                                  u64 addr,
3182                                                  size_t size,
3183                                                  enum dma_data_direction dir)
3184 {
3185         dma_sync_single_for_device(&dev->dev, addr, size, dir);
3186 }
3187
3188 /**
3189  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
3190  * @dev: The device for which the DMA address is requested
3191  * @size: The size of the region to allocate in bytes
3192  * @dma_handle: A pointer for returning the DMA address of the region
3193  * @flag: memory allocator flags
3194  */
3195 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
3196                                            size_t size,
3197                                            dma_addr_t *dma_handle,
3198                                            gfp_t flag)
3199 {
3200         return dma_alloc_coherent(&dev->dev, size, dma_handle, flag);
3201 }
3202
3203 /**
3204  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
3205  * @dev: The device for which the DMA addresses were allocated
3206  * @size: The size of the region
3207  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
3208  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
3209  */
3210 static inline void ib_dma_free_coherent(struct ib_device *dev,
3211                                         size_t size, void *cpu_addr,
3212                                         dma_addr_t dma_handle)
3213 {
3214         dma_free_coherent(&dev->dev, size, cpu_addr, dma_handle);
3215 }
3216
3217 /**
3218  * ib_dereg_mr - Deregisters a memory region and removes it from the
3219  *   HCA translation table.
3220  * @mr: The memory region to deregister.
3221  *
3222  * This function can fail, if the memory region has memory windows bound to it.
3223  */
3224 int ib_dereg_mr(struct ib_mr *mr);
3225
3226 struct ib_mr *ib_alloc_mr(struct ib_pd *pd,
3227                           enum ib_mr_type mr_type,
3228                           u32 max_num_sg);
3229
3230 /**
3231  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
3232  *   R_Key and L_Key.
3233  * @mr - struct ib_mr pointer to be updated.
3234  * @newkey - new key to be used.
3235  */
3236 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
3237 {
3238         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
3239         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
3240 }
3241
3242 /**
3243  * ib_inc_rkey - increments the key portion of the given rkey. Can be used
3244  * for calculating a new rkey for type 2 memory windows.
3245  * @rkey - the rkey to increment.
3246  */
3247 static inline u32 ib_inc_rkey(u32 rkey)
3248 {
3249         const u32 mask = 0x000000ff;
3250         return ((rkey + 1) & mask) | (rkey & ~mask);
3251 }
3252
3253 /**
3254  * ib_alloc_fmr - Allocates a unmapped fast memory region.
3255  * @pd: The protection domain associated with the unmapped region.
3256  * @mr_access_flags: Specifies the memory access rights.
3257  * @fmr_attr: Attributes of the unmapped region.
3258  *
3259  * A fast memory region must be mapped before it can be used as part of
3260  * a work request.
3261  */
3262 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
3263                             int mr_access_flags,
3264                             struct ib_fmr_attr *fmr_attr);
3265
3266 /**
3267  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
3268  * @fmr: The fast memory region to associate with the pages.
3269  * @page_list: An array of physical pages to map to the fast memory region.
3270  * @list_len: The number of pages in page_list.
3271  * @iova: The I/O virtual address to use with the mapped region.
3272  */
3273 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
3274                                   u64 *page_list, int list_len,
3275                                   u64 iova)
3276 {
3277         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
3278 }
3279
3280 /**
3281  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
3282  * @fmr_list: A linked list of fast memory regions to unmap.
3283  */
3284 int ib_unmap_fmr(struct list_head *fmr_list);
3285
3286 /**
3287  * ib_dealloc_fmr - Deallocates a fast memory region.
3288  * @fmr: The fast memory region to deallocate.
3289  */
3290 int ib_dealloc_fmr(struct ib_fmr *fmr);
3291
3292 /**
3293  * ib_attach_mcast - Attaches the specified QP to a multicast group.
3294  * @qp: QP to attach to the multicast group.  The QP must be type
3295  *   IB_QPT_UD.
3296  * @gid: Multicast group GID.
3297  * @lid: Multicast group LID in host byte order.
3298  *
3299  * In order to send and receive multicast packets, subnet
3300  * administration must have created the multicast group and configured
3301  * the fabric appropriately.  The port associated with the specified
3302  * QP must also be a member of the multicast group.
3303  */
3304 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
3305
3306 /**
3307  * ib_detach_mcast - Detaches the specified QP from a multicast group.
3308  * @qp: QP to detach from the multicast group.
3309  * @gid: Multicast group GID.
3310  * @lid: Multicast group LID in host byte order.
3311  */
3312 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
3313
3314 /**
3315  * ib_alloc_xrcd - Allocates an XRC domain.
3316  * @device: The device on which to allocate the XRC domain.
3317  */
3318 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
3319
3320 /**
3321  * ib_dealloc_xrcd - Deallocates an XRC domain.
3322  * @xrcd: The XRC domain to deallocate.
3323  */
3324 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
3325
3326 struct ib_flow *ib_create_flow(struct ib_qp *qp,
3327                                struct ib_flow_attr *flow_attr, int domain);
3328 int ib_destroy_flow(struct ib_flow *flow_id);
3329
3330 static inline int ib_check_mr_access(int flags)
3331 {
3332         /*
3333          * Local write permission is required if remote write or
3334          * remote atomic permission is also requested.
3335          */
3336         if (flags & (IB_ACCESS_REMOTE_ATOMIC | IB_ACCESS_REMOTE_WRITE) &&
3337             !(flags & IB_ACCESS_LOCAL_WRITE))
3338                 return -EINVAL;
3339
3340         return 0;
3341 }
3342
3343 /**
3344  * ib_check_mr_status: lightweight check of MR status.
3345  *     This routine may provide status checks on a selected
3346  *     ib_mr. first use is for signature status check.
3347  *
3348  * @mr: A memory region.
3349  * @check_mask: Bitmask of which checks to perform from
3350  *     ib_mr_status_check enumeration.
3351  * @mr_status: The container of relevant status checks.
3352  *     failed checks will be indicated in the status bitmask
3353  *     and the relevant info shall be in the error item.
3354  */
3355 int ib_check_mr_status(struct ib_mr *mr, u32 check_mask,
3356                        struct ib_mr_status *mr_status);
3357
3358 struct net_device *ib_get_net_dev_by_params(struct ib_device *dev, u8 port,
3359                                             u16 pkey, const union ib_gid *gid,
3360                                             const struct sockaddr *addr);
3361 struct ib_wq *ib_create_wq(struct ib_pd *pd,
3362                            struct ib_wq_init_attr *init_attr);
3363 int ib_destroy_wq(struct ib_wq *wq);
3364 int ib_modify_wq(struct ib_wq *wq, struct ib_wq_attr *attr,
3365                  u32 wq_attr_mask);
3366 struct ib_rwq_ind_table *ib_create_rwq_ind_table(struct ib_device *device,
3367                                                  struct ib_rwq_ind_table_init_attr*
3368                                                  wq_ind_table_init_attr);
3369 int ib_destroy_rwq_ind_table(struct ib_rwq_ind_table *wq_ind_table);
3370
3371 int ib_map_mr_sg(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
3372                  unsigned int *sg_offset, unsigned int page_size);
3373
3374 static inline int
3375 ib_map_mr_sg_zbva(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
3376                   unsigned int *sg_offset, unsigned int page_size)
3377 {
3378         int n;
3379
3380         n = ib_map_mr_sg(mr, sg, sg_nents, sg_offset, page_size);
3381         mr->iova = 0;
3382
3383         return n;
3384 }
3385
3386 int ib_sg_to_pages(struct ib_mr *mr, struct scatterlist *sgl, int sg_nents,
3387                 unsigned int *sg_offset, int (*set_page)(struct ib_mr *, u64));
3388
3389 void ib_drain_rq(struct ib_qp *qp);
3390 void ib_drain_sq(struct ib_qp *qp);
3391 void ib_drain_qp(struct ib_qp *qp);
3392
3393 int ib_resolve_eth_dmac(struct ib_device *device,
3394                         struct ib_ah_attr *ah_attr);
3395 #endif /* IB_VERBS_H */