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