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