SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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
  51 #include <asm/atomic.h>
  52 #include <asm/uaccess.h>
  53
  54 union ib_gid {
  55         u8      raw[16];
  56         struct {
  57                 __be64  subnet_prefix;
  58                 __be64  interface_id;
  59         } global;
  60 };
  61
  62 enum rdma_node_type {
  63         /* IB values map to NodeInfo:NodeType. */
  64         RDMA_NODE_IB_CA         = 1,
  65         RDMA_NODE_IB_SWITCH,
  66         RDMA_NODE_IB_ROUTER,
  67         RDMA_NODE_RNIC
  68 };
  69
  70 enum rdma_transport_type {
  71         RDMA_TRANSPORT_IB,
  72         RDMA_TRANSPORT_IWARP
  73 };
  74
  75 enum rdma_transport_type
  76 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
  77
  78 enum ib_device_cap_flags {
  79         IB_DEVICE_RESIZE_MAX_WR         = 1,
  80         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
  81         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
  82         IB_DEVICE_RAW_MULTI             = (1<<3),
  83         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
  84         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
  85         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
  86         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
  87         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
  88         IB_DEVICE_INIT_TYPE             = (1<<9),
  89         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
  90         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
  91         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
  92         IB_DEVICE_SRQ_RESIZE            = (1<<13),
  93         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
  94         IB_DEVICE_ZERO_STAG             = (1<<15),
  95         IB_DEVICE_RESERVED              = (1<<16), /* old SEND_W_INV */
  96         IB_DEVICE_MEM_WINDOW            = (1<<17),
  97         /*
  98          * Devices should set IB_DEVICE_UD_IP_SUM if they support
  99          * insertion of UDP and TCP checksum on outgoing UD IPoIB
 100          * messages and can verify the validity of checksum for
 101          * incoming messages.  Setting this flag implies that the
 102          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
 103          */
 104         IB_DEVICE_UD_IP_CSUM            = (1<<18),
 105         IB_DEVICE_UD_TSO                = (1<<19),
 106 };
 107
 108 enum ib_atomic_cap {
 109         IB_ATOMIC_NONE,
 110         IB_ATOMIC_HCA,
 111         IB_ATOMIC_GLOB
 112 };
 113
 114 struct ib_device_attr {
 115         u64                     fw_ver;
 116         __be64                  sys_image_guid;
 117         u64                     max_mr_size;
 118         u64                     page_size_cap;
 119         u32                     vendor_id;
 120         u32                     vendor_part_id;
 121         u32                     hw_ver;
 122         int                     max_qp;
 123         int                     max_qp_wr;
 124         int                     device_cap_flags;
 125         int                     max_sge;
 126         int                     max_sge_rd;
 127         int                     max_cq;
 128         int                     max_cqe;
 129         int                     max_mr;
 130         int                     max_pd;
 131         int                     max_qp_rd_atom;
 132         int                     max_ee_rd_atom;
 133         int                     max_res_rd_atom;
 134         int                     max_qp_init_rd_atom;
 135         int                     max_ee_init_rd_atom;
 136         enum ib_atomic_cap      atomic_cap;
 137         int                     max_ee;
 138         int                     max_rdd;
 139         int                     max_mw;
 140         int                     max_raw_ipv6_qp;
 141         int                     max_raw_ethy_qp;
 142         int                     max_mcast_grp;
 143         int                     max_mcast_qp_attach;
 144         int                     max_total_mcast_qp_attach;
 145         int                     max_ah;
 146         int                     max_fmr;
 147         int                     max_map_per_fmr;
 148         int                     max_srq;
 149         int                     max_srq_wr;
 150         int                     max_srq_sge;
 151         u16                     max_pkeys;
 152         u8                      local_ca_ack_delay;
 153 };
 154
 155 enum ib_mtu {
 156         IB_MTU_256  = 1,
 157         IB_MTU_512  = 2,
 158         IB_MTU_1024 = 3,
 159         IB_MTU_2048 = 4,
 160         IB_MTU_4096 = 5
 161 };
 162
 163 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 164 {
 165         switch (mtu) {
 166         case IB_MTU_256:  return  256;
 167         case IB_MTU_512:  return  512;
 168         case IB_MTU_1024: return 1024;
 169         case IB_MTU_2048: return 2048;
 170         case IB_MTU_4096: return 4096;
 171         default:          return -1;
 172         }
 173 }
 174
 175 enum ib_port_state {
 176         IB_PORT_NOP             = 0,
 177         IB_PORT_DOWN            = 1,
 178         IB_PORT_INIT            = 2,
 179         IB_PORT_ARMED           = 3,
 180         IB_PORT_ACTIVE          = 4,
 181         IB_PORT_ACTIVE_DEFER    = 5
 182 };
 183
 184 enum ib_port_cap_flags {
 185         IB_PORT_SM                              = 1 <<  1,
 186         IB_PORT_NOTICE_SUP                      = 1 <<  2,
 187         IB_PORT_TRAP_SUP                        = 1 <<  3,
 188         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
 189         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
 190         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
 191         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
 192         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
 193         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
 194         IB_PORT_SM_DISABLED                     = 1 << 10,
 195         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
 196         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
 197         IB_PORT_CM_SUP                          = 1 << 16,
 198         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
 199         IB_PORT_REINIT_SUP                      = 1 << 18,
 200         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
 201         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
 202         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
 203         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
 204         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
 205         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
 206         IB_PORT_CLIENT_REG_SUP                  = 1 << 25
 207 };
 208
 209 enum ib_port_width {
 210         IB_WIDTH_1X     = 1,
 211         IB_WIDTH_4X     = 2,
 212         IB_WIDTH_8X     = 4,
 213         IB_WIDTH_12X    = 8
 214 };
 215
 216 static inline int ib_width_enum_to_int(enum ib_port_width width)
 217 {
 218         switch (width) {
 219         case IB_WIDTH_1X:  return  1;
 220         case IB_WIDTH_4X:  return  4;
 221         case IB_WIDTH_8X:  return  8;
 222         case IB_WIDTH_12X: return 12;
 223         default:          return -1;
 224         }
 225 }
 226
 227 struct ib_port_attr {
 228         enum ib_port_state      state;
 229         enum ib_mtu             max_mtu;
 230         enum ib_mtu             active_mtu;
 231         int                     gid_tbl_len;
 232         u32                     port_cap_flags;
 233         u32                     max_msg_sz;
 234         u32                     bad_pkey_cntr;
 235         u32                     qkey_viol_cntr;
 236         u16                     pkey_tbl_len;
 237         u16                     lid;
 238         u16                     sm_lid;
 239         u8                      lmc;
 240         u8                      max_vl_num;
 241         u8                      sm_sl;
 242         u8                      subnet_timeout;
 243         u8                      init_type_reply;
 244         u8                      active_width;
 245         u8                      active_speed;
 246         u8                      phys_state;
 247 };
 248
 249 enum ib_device_modify_flags {
 250         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
 251         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
 252 };
 253
 254 struct ib_device_modify {
 255         u64     sys_image_guid;
 256         char    node_desc[64];
 257 };
 258
 259 enum ib_port_modify_flags {
 260         IB_PORT_SHUTDOWN                = 1,
 261         IB_PORT_INIT_TYPE               = (1<<2),
 262         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
 263 };
 264
 265 struct ib_port_modify {
 266         u32     set_port_cap_mask;
 267         u32     clr_port_cap_mask;
 268         u8      init_type;
 269 };
 270
 271 enum ib_event_type {
 272         IB_EVENT_CQ_ERR,
 273         IB_EVENT_QP_FATAL,
 274         IB_EVENT_QP_REQ_ERR,
 275         IB_EVENT_QP_ACCESS_ERR,
 276         IB_EVENT_COMM_EST,
 277         IB_EVENT_SQ_DRAINED,
 278         IB_EVENT_PATH_MIG,
 279         IB_EVENT_PATH_MIG_ERR,
 280         IB_EVENT_DEVICE_FATAL,
 281         IB_EVENT_PORT_ACTIVE,
 282         IB_EVENT_PORT_ERR,
 283         IB_EVENT_LID_CHANGE,
 284         IB_EVENT_PKEY_CHANGE,
 285         IB_EVENT_SM_CHANGE,
 286         IB_EVENT_SRQ_ERR,
 287         IB_EVENT_SRQ_LIMIT_REACHED,
 288         IB_EVENT_QP_LAST_WQE_REACHED,
 289         IB_EVENT_CLIENT_REREGISTER
 290 };
 291
 292 struct ib_event {
 293         struct ib_device        *device;
 294         union {
 295                 struct ib_cq    *cq;
 296                 struct ib_qp    *qp;
 297                 struct ib_srq   *srq;
 298                 u8              port_num;
 299         } element;
 300         enum ib_event_type      event;
 301 };
 302
 303 struct ib_event_handler {
 304         struct ib_device *device;
 305         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 306         struct list_head  list;
 307 };
 308
 309 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 310         do {                                                    \
 311                 (_ptr)->device  = _device;                      \
 312                 (_ptr)->handler = _handler;                     \
 313                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 314         } while (0)
 315
 316 struct ib_global_route {
 317         union ib_gid    dgid;
 318         u32             flow_label;
 319         u8              sgid_index;
 320         u8              hop_limit;
 321         u8              traffic_class;
 322 };
 323
 324 struct ib_grh {
 325         __be32          version_tclass_flow;
 326         __be16          paylen;
 327         u8              next_hdr;
 328         u8              hop_limit;
 329         union ib_gid    sgid;
 330         union ib_gid    dgid;
 331 };
 332
 333 enum {
 334         IB_MULTICAST_QPN = 0xffffff
 335 };
 336
 337 #define IB_LID_PERMISSIVE       __constant_htons(0xFFFF)
 338
 339 enum ib_ah_flags {
 340         IB_AH_GRH       = 1
 341 };
 342
 343 enum ib_rate {
 344         IB_RATE_PORT_CURRENT = 0,
 345         IB_RATE_2_5_GBPS = 2,
 346         IB_RATE_5_GBPS   = 5,
 347         IB_RATE_10_GBPS  = 3,
 348         IB_RATE_20_GBPS  = 6,
 349         IB_RATE_30_GBPS  = 4,
 350         IB_RATE_40_GBPS  = 7,
 351         IB_RATE_60_GBPS  = 8,
 352         IB_RATE_80_GBPS  = 9,
 353         IB_RATE_120_GBPS = 10
 354 };
 355
 356 /**
 357  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
 358  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
 359  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
 360  * @rate: rate to convert.
 361  */
 362 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
 363
 364 /**
 365  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
 366  * enum.
 367  * @mult: multiple to convert.
 368  */
 369 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
 370
 371 struct ib_ah_attr {
 372         struct ib_global_route  grh;
 373         u16                     dlid;
 374         u8                      sl;
 375         u8                      src_path_bits;
 376         u8                      static_rate;
 377         u8                      ah_flags;
 378         u8                      port_num;
 379 };
 380
 381 enum ib_wc_status {
 382         IB_WC_SUCCESS,
 383         IB_WC_LOC_LEN_ERR,
 384         IB_WC_LOC_QP_OP_ERR,
 385         IB_WC_LOC_EEC_OP_ERR,
 386         IB_WC_LOC_PROT_ERR,
 387         IB_WC_WR_FLUSH_ERR,
 388         IB_WC_MW_BIND_ERR,
 389         IB_WC_BAD_RESP_ERR,
 390         IB_WC_LOC_ACCESS_ERR,
 391         IB_WC_REM_INV_REQ_ERR,
 392         IB_WC_REM_ACCESS_ERR,
 393         IB_WC_REM_OP_ERR,
 394         IB_WC_RETRY_EXC_ERR,
 395         IB_WC_RNR_RETRY_EXC_ERR,
 396         IB_WC_LOC_RDD_VIOL_ERR,
 397         IB_WC_REM_INV_RD_REQ_ERR,
 398         IB_WC_REM_ABORT_ERR,
 399         IB_WC_INV_EECN_ERR,
 400         IB_WC_INV_EEC_STATE_ERR,
 401         IB_WC_FATAL_ERR,
 402         IB_WC_RESP_TIMEOUT_ERR,
 403         IB_WC_GENERAL_ERR
 404 };
 405
 406 enum ib_wc_opcode {
 407         IB_WC_SEND,
 408         IB_WC_RDMA_WRITE,
 409         IB_WC_RDMA_READ,
 410         IB_WC_COMP_SWAP,
 411         IB_WC_FETCH_ADD,
 412         IB_WC_BIND_MW,
 413         IB_WC_LSO,
 414 /*
 415  * Set value of IB_WC_RECV so consumers can test if a completion is a
 416  * receive by testing (opcode & IB_WC_RECV).
 417  */
 418         IB_WC_RECV                      = 1 << 7,
 419         IB_WC_RECV_RDMA_WITH_IMM
 420 };
 421
 422 enum ib_wc_flags {
 423         IB_WC_GRH               = 1,
 424         IB_WC_WITH_IMM          = (1<<1)
 425 };
 426
 427 struct ib_wc {
 428         u64                     wr_id;
 429         enum ib_wc_status       status;
 430         enum ib_wc_opcode       opcode;
 431         u32                     vendor_err;
 432         u32                     byte_len;
 433         struct ib_qp           *qp;
 434         __be32                  imm_data;
 435         u32                     src_qp;
 436         int                     wc_flags;
 437         u16                     pkey_index;
 438         u16                     slid;
 439         u8                      sl;
 440         u8                      dlid_path_bits;
 441         u8                      port_num;       /* valid only for DR SMPs on switches */
 442         int                     csum_ok;
 443 };
 444
 445 enum ib_cq_notify_flags {
 446         IB_CQ_SOLICITED                 = 1 << 0,
 447         IB_CQ_NEXT_COMP                 = 1 << 1,
 448         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
 449         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
 450 };
 451
 452 enum ib_srq_attr_mask {
 453         IB_SRQ_MAX_WR   = 1 << 0,
 454         IB_SRQ_LIMIT    = 1 << 1,
 455 };
 456
 457 struct ib_srq_attr {
 458         u32     max_wr;
 459         u32     max_sge;
 460         u32     srq_limit;
 461 };
 462
 463 struct ib_srq_init_attr {
 464         void                  (*event_handler)(struct ib_event *, void *);
 465         void                   *srq_context;
 466         struct ib_srq_attr      attr;
 467 };
 468
 469 struct ib_qp_cap {
 470         u32     max_send_wr;
 471         u32     max_recv_wr;
 472         u32     max_send_sge;
 473         u32     max_recv_sge;
 474         u32     max_inline_data;
 475 };
 476
 477 enum ib_sig_type {
 478         IB_SIGNAL_ALL_WR,
 479         IB_SIGNAL_REQ_WR
 480 };
 481
 482 enum ib_qp_type {
 483         /*
 484          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
 485          * here (and in that order) since the MAD layer uses them as
 486          * indices into a 2-entry table.
 487          */
 488         IB_QPT_SMI,
 489         IB_QPT_GSI,
 490
 491         IB_QPT_RC,
 492         IB_QPT_UC,
 493         IB_QPT_UD,
 494         IB_QPT_RAW_IPV6,
 495         IB_QPT_RAW_ETY
 496 };
 497
 498 enum ib_qp_create_flags {
 499         IB_QP_CREATE_IPOIB_UD_LSO       = 1 << 0,
 500 };
 501
 502 struct ib_qp_init_attr {
 503         void                  (*event_handler)(struct ib_event *, void *);
 504         void                   *qp_context;
 505         struct ib_cq           *send_cq;
 506         struct ib_cq           *recv_cq;
 507         struct ib_srq          *srq;
 508         struct ib_qp_cap        cap;
 509         enum ib_sig_type        sq_sig_type;
 510         enum ib_qp_type         qp_type;
 511         enum ib_qp_create_flags create_flags;
 512         u8                      port_num; /* special QP types only */
 513 };
 514
 515 enum ib_rnr_timeout {
 516         IB_RNR_TIMER_655_36 =  0,
 517         IB_RNR_TIMER_000_01 =  1,
 518         IB_RNR_TIMER_000_02 =  2,
 519         IB_RNR_TIMER_000_03 =  3,
 520         IB_RNR_TIMER_000_04 =  4,
 521         IB_RNR_TIMER_000_06 =  5,
 522         IB_RNR_TIMER_000_08 =  6,
 523         IB_RNR_TIMER_000_12 =  7,
 524         IB_RNR_TIMER_000_16 =  8,
 525         IB_RNR_TIMER_000_24 =  9,
 526         IB_RNR_TIMER_000_32 = 10,
 527         IB_RNR_TIMER_000_48 = 11,
 528         IB_RNR_TIMER_000_64 = 12,
 529         IB_RNR_TIMER_000_96 = 13,
 530         IB_RNR_TIMER_001_28 = 14,
 531         IB_RNR_TIMER_001_92 = 15,
 532         IB_RNR_TIMER_002_56 = 16,
 533         IB_RNR_TIMER_003_84 = 17,
 534         IB_RNR_TIMER_005_12 = 18,
 535         IB_RNR_TIMER_007_68 = 19,
 536         IB_RNR_TIMER_010_24 = 20,
 537         IB_RNR_TIMER_015_36 = 21,
 538         IB_RNR_TIMER_020_48 = 22,
 539         IB_RNR_TIMER_030_72 = 23,
 540         IB_RNR_TIMER_040_96 = 24,
 541         IB_RNR_TIMER_061_44 = 25,
 542         IB_RNR_TIMER_081_92 = 26,
 543         IB_RNR_TIMER_122_88 = 27,
 544         IB_RNR_TIMER_163_84 = 28,
 545         IB_RNR_TIMER_245_76 = 29,
 546         IB_RNR_TIMER_327_68 = 30,
 547         IB_RNR_TIMER_491_52 = 31
 548 };
 549
 550 enum ib_qp_attr_mask {
 551         IB_QP_STATE                     = 1,
 552         IB_QP_CUR_STATE                 = (1<<1),
 553         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
 554         IB_QP_ACCESS_FLAGS              = (1<<3),
 555         IB_QP_PKEY_INDEX                = (1<<4),
 556         IB_QP_PORT                      = (1<<5),
 557         IB_QP_QKEY                      = (1<<6),
 558         IB_QP_AV                        = (1<<7),
 559         IB_QP_PATH_MTU                  = (1<<8),
 560         IB_QP_TIMEOUT                   = (1<<9),
 561         IB_QP_RETRY_CNT                 = (1<<10),
 562         IB_QP_RNR_RETRY                 = (1<<11),
 563         IB_QP_RQ_PSN                    = (1<<12),
 564         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
 565         IB_QP_ALT_PATH                  = (1<<14),
 566         IB_QP_MIN_RNR_TIMER             = (1<<15),
 567         IB_QP_SQ_PSN                    = (1<<16),
 568         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
 569         IB_QP_PATH_MIG_STATE            = (1<<18),
 570         IB_QP_CAP                       = (1<<19),
 571         IB_QP_DEST_QPN                  = (1<<20)
 572 };
 573
 574 enum ib_qp_state {
 575         IB_QPS_RESET,
 576         IB_QPS_INIT,
 577         IB_QPS_RTR,
 578         IB_QPS_RTS,
 579         IB_QPS_SQD,
 580         IB_QPS_SQE,
 581         IB_QPS_ERR
 582 };
 583
 584 enum ib_mig_state {
 585         IB_MIG_MIGRATED,
 586         IB_MIG_REARM,
 587         IB_MIG_ARMED
 588 };
 589
 590 struct ib_qp_attr {
 591         enum ib_qp_state        qp_state;
 592         enum ib_qp_state        cur_qp_state;
 593         enum ib_mtu             path_mtu;
 594         enum ib_mig_state       path_mig_state;
 595         u32                     qkey;
 596         u32                     rq_psn;
 597         u32                     sq_psn;
 598         u32                     dest_qp_num;
 599         int                     qp_access_flags;
 600         struct ib_qp_cap        cap;
 601         struct ib_ah_attr       ah_attr;
 602         struct ib_ah_attr       alt_ah_attr;
 603         u16                     pkey_index;
 604         u16                     alt_pkey_index;
 605         u8                      en_sqd_async_notify;
 606         u8                      sq_draining;
 607         u8                      max_rd_atomic;
 608         u8                      max_dest_rd_atomic;
 609         u8                      min_rnr_timer;
 610         u8                      port_num;
 611         u8                      timeout;
 612         u8                      retry_cnt;
 613         u8                      rnr_retry;
 614         u8                      alt_port_num;
 615         u8                      alt_timeout;
 616 };
 617
 618 enum ib_wr_opcode {
 619         IB_WR_RDMA_WRITE,
 620         IB_WR_RDMA_WRITE_WITH_IMM,
 621         IB_WR_SEND,
 622         IB_WR_SEND_WITH_IMM,
 623         IB_WR_RDMA_READ,
 624         IB_WR_ATOMIC_CMP_AND_SWP,
 625         IB_WR_ATOMIC_FETCH_AND_ADD,
 626         IB_WR_LSO,
 627         IB_WR_SEND_WITH_INV,
 628 };
 629
 630 enum ib_send_flags {
 631         IB_SEND_FENCE           = 1,
 632         IB_SEND_SIGNALED        = (1<<1),
 633         IB_SEND_SOLICITED       = (1<<2),
 634         IB_SEND_INLINE          = (1<<3),
 635         IB_SEND_IP_CSUM         = (1<<4)
 636 };
 637
 638 struct ib_sge {
 639         u64     addr;
 640         u32     length;
 641         u32     lkey;
 642 };
 643
 644 struct ib_send_wr {
 645         struct ib_send_wr      *next;
 646         u64                     wr_id;
 647         struct ib_sge          *sg_list;
 648         int                     num_sge;
 649         enum ib_wr_opcode       opcode;
 650         int                     send_flags;
 651         union {
 652                 __be32          imm_data;
 653                 u32             invalidate_rkey;
 654         } ex;
 655         union {
 656                 struct {
 657                         u64     remote_addr;
 658                         u32     rkey;
 659                 } rdma;
 660                 struct {
 661                         u64     remote_addr;
 662                         u64     compare_add;
 663                         u64     swap;
 664                         u32     rkey;
 665                 } atomic;
 666                 struct {
 667                         struct ib_ah *ah;
 668                         void   *header;
 669                         int     hlen;
 670                         int     mss;
 671                         u32     remote_qpn;
 672                         u32     remote_qkey;
 673                         u16     pkey_index; /* valid for GSI only */
 674                         u8      port_num;   /* valid for DR SMPs on switch only */
 675                 } ud;
 676         } wr;
 677 };
 678
 679 struct ib_recv_wr {
 680         struct ib_recv_wr      *next;
 681         u64                     wr_id;
 682         struct ib_sge          *sg_list;
 683         int                     num_sge;
 684 };
 685
 686 enum ib_access_flags {
 687         IB_ACCESS_LOCAL_WRITE   = 1,
 688         IB_ACCESS_REMOTE_WRITE  = (1<<1),
 689         IB_ACCESS_REMOTE_READ   = (1<<2),
 690         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
 691         IB_ACCESS_MW_BIND       = (1<<4)
 692 };
 693
 694 struct ib_phys_buf {
 695         u64      addr;
 696         u64      size;
 697 };
 698
 699 struct ib_mr_attr {
 700         struct ib_pd    *pd;
 701         u64             device_virt_addr;
 702         u64             size;
 703         int             mr_access_flags;
 704         u32             lkey;
 705         u32             rkey;
 706 };
 707
 708 enum ib_mr_rereg_flags {
 709         IB_MR_REREG_TRANS       = 1,
 710         IB_MR_REREG_PD          = (1<<1),
 711         IB_MR_REREG_ACCESS      = (1<<2)
 712 };
 713
 714 struct ib_mw_bind {
 715         struct ib_mr   *mr;
 716         u64             wr_id;
 717         u64             addr;
 718         u32             length;
 719         int             send_flags;
 720         int             mw_access_flags;
 721 };
 722
 723 struct ib_fmr_attr {
 724         int     max_pages;
 725         int     max_maps;
 726         u8      page_shift;
 727 };
 728
 729 struct ib_ucontext {
 730         struct ib_device       *device;
 731         struct list_head        pd_list;
 732         struct list_head        mr_list;
 733         struct list_head        mw_list;
 734         struct list_head        cq_list;
 735         struct list_head        qp_list;
 736         struct list_head        srq_list;
 737         struct list_head        ah_list;
 738         int                     closing;
 739 };
 740
 741 struct ib_uobject {
 742         u64                     user_handle;    /* handle given to us by userspace */
 743         struct ib_ucontext     *context;        /* associated user context */
 744         void                   *object;         /* containing object */
 745         struct list_head        list;           /* link to context's list */
 746         int                     id;             /* index into kernel idr */
 747         struct kref             ref;
 748         struct rw_semaphore     mutex;          /* protects .live */
 749         int                     live;
 750 };
 751
 752 struct ib_udata {
 753         void __user *inbuf;
 754         void __user *outbuf;
 755         size_t       inlen;
 756         size_t       outlen;
 757 };
 758
 759 struct ib_pd {
 760         struct ib_device       *device;
 761         struct ib_uobject      *uobject;
 762         atomic_t                usecnt; /* count all resources */
 763 };
 764
 765 struct ib_ah {
 766         struct ib_device        *device;
 767         struct ib_pd            *pd;
 768         struct ib_uobject       *uobject;
 769 };
 770
 771 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
 772
 773 struct ib_cq {
 774         struct ib_device       *device;
 775         struct ib_uobject      *uobject;
 776         ib_comp_handler         comp_handler;
 777         void                  (*event_handler)(struct ib_event *, void *);
 778         void                   *cq_context;
 779         int                     cqe;
 780         atomic_t                usecnt; /* count number of work queues */
 781 };
 782
 783 struct ib_srq {
 784         struct ib_device       *device;
 785         struct ib_pd           *pd;
 786         struct ib_uobject      *uobject;
 787         void                  (*event_handler)(struct ib_event *, void *);
 788         void                   *srq_context;
 789         atomic_t                usecnt;
 790 };
 791
 792 struct ib_qp {
 793         struct ib_device       *device;
 794         struct ib_pd           *pd;
 795         struct ib_cq           *send_cq;
 796         struct ib_cq           *recv_cq;
 797         struct ib_srq          *srq;
 798         struct ib_uobject      *uobject;
 799         void                  (*event_handler)(struct ib_event *, void *);
 800         void                   *qp_context;
 801         u32                     qp_num;
 802         enum ib_qp_type         qp_type;
 803 };
 804
 805 struct ib_mr {
 806         struct ib_device  *device;
 807         struct ib_pd      *pd;
 808         struct ib_uobject *uobject;
 809         u32                lkey;
 810         u32                rkey;
 811         atomic_t           usecnt; /* count number of MWs */
 812 };
 813
 814 struct ib_mw {
 815         struct ib_device        *device;
 816         struct ib_pd            *pd;
 817         struct ib_uobject       *uobject;
 818         u32                     rkey;
 819 };
 820
 821 struct ib_fmr {
 822         struct ib_device        *device;
 823         struct ib_pd            *pd;
 824         struct list_head        list;
 825         u32                     lkey;
 826         u32                     rkey;
 827 };
 828
 829 struct ib_mad;
 830 struct ib_grh;
 831
 832 enum ib_process_mad_flags {
 833         IB_MAD_IGNORE_MKEY      = 1,
 834         IB_MAD_IGNORE_BKEY      = 2,
 835         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
 836 };
 837
 838 enum ib_mad_result {
 839         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
 840         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
 841         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
 842         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
 843 };
 844
 845 #define IB_DEVICE_NAME_MAX 64
 846
 847 struct ib_cache {
 848         rwlock_t                lock;
 849         struct ib_event_handler event_handler;
 850         struct ib_pkey_cache  **pkey_cache;
 851         struct ib_gid_cache   **gid_cache;
 852         u8                     *lmc_cache;
 853 };
 854
 855 struct ib_dma_mapping_ops {
 856         int             (*mapping_error)(struct ib_device *dev,
 857                                          u64 dma_addr);
 858         u64             (*map_single)(struct ib_device *dev,
 859                                       void *ptr, size_t size,
 860                                       enum dma_data_direction direction);
 861         void            (*unmap_single)(struct ib_device *dev,
 862                                         u64 addr, size_t size,
 863                                         enum dma_data_direction direction);
 864         u64             (*map_page)(struct ib_device *dev,
 865                                     struct page *page, unsigned long offset,
 866                                     size_t size,
 867                                     enum dma_data_direction direction);
 868         void            (*unmap_page)(struct ib_device *dev,
 869                                       u64 addr, size_t size,
 870                                       enum dma_data_direction direction);
 871         int             (*map_sg)(struct ib_device *dev,
 872                                   struct scatterlist *sg, int nents,
 873                                   enum dma_data_direction direction);
 874         void            (*unmap_sg)(struct ib_device *dev,
 875                                     struct scatterlist *sg, int nents,
 876                                     enum dma_data_direction direction);
 877         u64             (*dma_address)(struct ib_device *dev,
 878                                        struct scatterlist *sg);
 879         unsigned int    (*dma_len)(struct ib_device *dev,
 880                                    struct scatterlist *sg);
 881         void            (*sync_single_for_cpu)(struct ib_device *dev,
 882                                                u64 dma_handle,
 883                                                size_t size,
 884                                                enum dma_data_direction dir);
 885         void            (*sync_single_for_device)(struct ib_device *dev,
 886                                                   u64 dma_handle,
 887                                                   size_t size,
 888                                                   enum dma_data_direction dir);
 889         void            *(*alloc_coherent)(struct ib_device *dev,
 890                                            size_t size,
 891                                            u64 *dma_handle,
 892                                            gfp_t flag);
 893         void            (*free_coherent)(struct ib_device *dev,
 894                                          size_t size, void *cpu_addr,
 895                                          u64 dma_handle);
 896 };
 897
 898 struct iw_cm_verbs;
 899
 900 struct ib_device {
 901         struct device                *dma_device;
 902
 903         char                          name[IB_DEVICE_NAME_MAX];
 904
 905         struct list_head              event_handler_list;
 906         spinlock_t                    event_handler_lock;
 907
 908         struct list_head              core_list;
 909         struct list_head              client_data_list;
 910         spinlock_t                    client_data_lock;
 911
 912         struct ib_cache               cache;
 913         int                          *pkey_tbl_len;
 914         int                          *gid_tbl_len;
 915
 916         int                           num_comp_vectors;
 917
 918         struct iw_cm_verbs           *iwcm;
 919
 920         int                        (*query_device)(struct ib_device *device,
 921                                                    struct ib_device_attr *device_attr);
 922         int                        (*query_port)(struct ib_device *device,
 923                                                  u8 port_num,
 924                                                  struct ib_port_attr *port_attr);
 925         int                        (*query_gid)(struct ib_device *device,
 926                                                 u8 port_num, int index,
 927                                                 union ib_gid *gid);
 928         int                        (*query_pkey)(struct ib_device *device,
 929                                                  u8 port_num, u16 index, u16 *pkey);
 930         int                        (*modify_device)(struct ib_device *device,
 931                                                     int device_modify_mask,
 932                                                     struct ib_device_modify *device_modify);
 933         int                        (*modify_port)(struct ib_device *device,
 934                                                   u8 port_num, int port_modify_mask,
 935                                                   struct ib_port_modify *port_modify);
 936         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
 937                                                      struct ib_udata *udata);
 938         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
 939         int                        (*mmap)(struct ib_ucontext *context,
 940                                            struct vm_area_struct *vma);
 941         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
 942                                                struct ib_ucontext *context,
 943                                                struct ib_udata *udata);
 944         int                        (*dealloc_pd)(struct ib_pd *pd);
 945         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
 946                                                 struct ib_ah_attr *ah_attr);
 947         int                        (*modify_ah)(struct ib_ah *ah,
 948                                                 struct ib_ah_attr *ah_attr);
 949         int                        (*query_ah)(struct ib_ah *ah,
 950                                                struct ib_ah_attr *ah_attr);
 951         int                        (*destroy_ah)(struct ib_ah *ah);
 952         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
 953                                                  struct ib_srq_init_attr *srq_init_attr,
 954                                                  struct ib_udata *udata);
 955         int                        (*modify_srq)(struct ib_srq *srq,
 956                                                  struct ib_srq_attr *srq_attr,
 957                                                  enum ib_srq_attr_mask srq_attr_mask,
 958                                                  struct ib_udata *udata);
 959         int                        (*query_srq)(struct ib_srq *srq,
 960                                                 struct ib_srq_attr *srq_attr);
 961         int                        (*destroy_srq)(struct ib_srq *srq);
 962         int                        (*post_srq_recv)(struct ib_srq *srq,
 963                                                     struct ib_recv_wr *recv_wr,
 964                                                     struct ib_recv_wr **bad_recv_wr);
 965         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
 966                                                 struct ib_qp_init_attr *qp_init_attr,
 967                                                 struct ib_udata *udata);
 968         int                        (*modify_qp)(struct ib_qp *qp,
 969                                                 struct ib_qp_attr *qp_attr,
 970                                                 int qp_attr_mask,
 971                                                 struct ib_udata *udata);
 972         int                        (*query_qp)(struct ib_qp *qp,
 973                                                struct ib_qp_attr *qp_attr,
 974                                                int qp_attr_mask,
 975                                                struct ib_qp_init_attr *qp_init_attr);
 976         int                        (*destroy_qp)(struct ib_qp *qp);
 977         int                        (*post_send)(struct ib_qp *qp,
 978                                                 struct ib_send_wr *send_wr,
 979                                                 struct ib_send_wr **bad_send_wr);
 980         int                        (*post_recv)(struct ib_qp *qp,
 981                                                 struct ib_recv_wr *recv_wr,
 982                                                 struct ib_recv_wr **bad_recv_wr);
 983         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
 984                                                 int comp_vector,
 985                                                 struct ib_ucontext *context,
 986                                                 struct ib_udata *udata);
 987         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
 988                                                 u16 cq_period);
 989         int                        (*destroy_cq)(struct ib_cq *cq);
 990         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
 991                                                 struct ib_udata *udata);
 992         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
 993                                               struct ib_wc *wc);
 994         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
 995         int                        (*req_notify_cq)(struct ib_cq *cq,
 996                                                     enum ib_cq_notify_flags flags);
 997         int                        (*req_ncomp_notif)(struct ib_cq *cq,
 998                                                       int wc_cnt);
 999         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
1000                                                  int mr_access_flags);
1001         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
1002                                                   struct ib_phys_buf *phys_buf_array,
1003                                                   int num_phys_buf,
1004                                                   int mr_access_flags,
1005                                                   u64 *iova_start);
1006         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1007                                                   u64 start, u64 length,
1008                                                   u64 virt_addr,
1009                                                   int mr_access_flags,
1010                                                   struct ib_udata *udata);
1011         int                        (*query_mr)(struct ib_mr *mr,
1012                                                struct ib_mr_attr *mr_attr);
1013         int                        (*dereg_mr)(struct ib_mr *mr);
1014         int                        (*rereg_phys_mr)(struct ib_mr *mr,
1015                                                     int mr_rereg_mask,
1016                                                     struct ib_pd *pd,
1017                                                     struct ib_phys_buf *phys_buf_array,
1018                                                     int num_phys_buf,
1019                                                     int mr_access_flags,
1020                                                     u64 *iova_start);
1021         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
1022         int                        (*bind_mw)(struct ib_qp *qp,
1023                                               struct ib_mw *mw,
1024                                               struct ib_mw_bind *mw_bind);
1025         int                        (*dealloc_mw)(struct ib_mw *mw);
1026         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1027                                                 int mr_access_flags,
1028                                                 struct ib_fmr_attr *fmr_attr);
1029         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1030                                                    u64 *page_list, int list_len,
1031                                                    u64 iova);
1032         int                        (*unmap_fmr)(struct list_head *fmr_list);
1033         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1034         int                        (*attach_mcast)(struct ib_qp *qp,
1035                                                    union ib_gid *gid,
1036                                                    u16 lid);
1037         int                        (*detach_mcast)(struct ib_qp *qp,
1038                                                    union ib_gid *gid,
1039                                                    u16 lid);
1040         int                        (*process_mad)(struct ib_device *device,
1041                                                   int process_mad_flags,
1042                                                   u8 port_num,
1043                                                   struct ib_wc *in_wc,
1044                                                   struct ib_grh *in_grh,
1045                                                   struct ib_mad *in_mad,
1046                                                   struct ib_mad *out_mad);
1047
1048         struct ib_dma_mapping_ops   *dma_ops;
1049
1050         struct module               *owner;
1051         struct device                dev;
1052         struct kobject               *ports_parent;
1053         struct list_head             port_list;
1054
1055         enum {
1056                 IB_DEV_UNINITIALIZED,
1057                 IB_DEV_REGISTERED,
1058                 IB_DEV_UNREGISTERED
1059         }                            reg_state;
1060
1061         u64                          uverbs_cmd_mask;
1062         int                          uverbs_abi_ver;
1063
1064         char                         node_desc[64];
1065         __be64                       node_guid;
1066         u8                           node_type;
1067         u8                           phys_port_cnt;
1068 };
1069
1070 struct ib_client {
1071         char  *name;
1072         void (*add)   (struct ib_device *);
1073         void (*remove)(struct ib_device *);
1074
1075         struct list_head list;
1076 };
1077
1078 struct ib_device *ib_alloc_device(size_t size);
1079 void ib_dealloc_device(struct ib_device *device);
1080
1081 int ib_register_device   (struct ib_device *device);
1082 void ib_unregister_device(struct ib_device *device);
1083
1084 int ib_register_client   (struct ib_client *client);
1085 void ib_unregister_client(struct ib_client *client);
1086
1087 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1088 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1089                          void *data);
1090
1091 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1092 {
1093         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1094 }
1095
1096 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1097 {
1098         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1099 }
1100
1101 /**
1102  * ib_modify_qp_is_ok - Check that the supplied attribute mask
1103  * contains all required attributes and no attributes not allowed for
1104  * the given QP state transition.
1105  * @cur_state: Current QP state
1106  * @next_state: Next QP state
1107  * @type: QP type
1108  * @mask: Mask of supplied QP attributes
1109  *
1110  * This function is a helper function that a low-level driver's
1111  * modify_qp method can use to validate the consumer's input.  It
1112  * checks that cur_state and next_state are valid QP states, that a
1113  * transition from cur_state to next_state is allowed by the IB spec,
1114  * and that the attribute mask supplied is allowed for the transition.
1115  */
1116 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1117                        enum ib_qp_type type, enum ib_qp_attr_mask mask);
1118
1119 int ib_register_event_handler  (struct ib_event_handler *event_handler);
1120 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1121 void ib_dispatch_event(struct ib_event *event);
1122
1123 int ib_query_device(struct ib_device *device,
1124                     struct ib_device_attr *device_attr);
1125
1126 int ib_query_port(struct ib_device *device,
1127                   u8 port_num, struct ib_port_attr *port_attr);
1128
1129 int ib_query_gid(struct ib_device *device,
1130                  u8 port_num, int index, union ib_gid *gid);
1131
1132 int ib_query_pkey(struct ib_device *device,
1133                   u8 port_num, u16 index, u16 *pkey);
1134
1135 int ib_modify_device(struct ib_device *device,
1136                      int device_modify_mask,
1137                      struct ib_device_modify *device_modify);
1138
1139 int ib_modify_port(struct ib_device *device,
1140                    u8 port_num, int port_modify_mask,
1141                    struct ib_port_modify *port_modify);
1142
1143 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1144                 u8 *port_num, u16 *index);
1145
1146 int ib_find_pkey(struct ib_device *device,
1147                  u8 port_num, u16 pkey, u16 *index);
1148
1149 /**
1150  * ib_alloc_pd - Allocates an unused protection domain.
1151  * @device: The device on which to allocate the protection domain.
1152  *
1153  * A protection domain object provides an association between QPs, shared
1154  * receive queues, address handles, memory regions, and memory windows.
1155  */
1156 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1157
1158 /**
1159  * ib_dealloc_pd - Deallocates a protection domain.
1160  * @pd: The protection domain to deallocate.
1161  */
1162 int ib_dealloc_pd(struct ib_pd *pd);
1163
1164 /**
1165  * ib_create_ah - Creates an address handle for the given address vector.
1166  * @pd: The protection domain associated with the address handle.
1167  * @ah_attr: The attributes of the address vector.
1168  *
1169  * The address handle is used to reference a local or global destination
1170  * in all UD QP post sends.
1171  */
1172 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1173
1174 /**
1175  * ib_init_ah_from_wc - Initializes address handle attributes from a
1176  *   work completion.
1177  * @device: Device on which the received message arrived.
1178  * @port_num: Port on which the received message arrived.
1179  * @wc: Work completion associated with the received message.
1180  * @grh: References the received global route header.  This parameter is
1181  *   ignored unless the work completion indicates that the GRH is valid.
1182  * @ah_attr: Returned attributes that can be used when creating an address
1183  *   handle for replying to the message.
1184  */
1185 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1186                        struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1187
1188 /**
1189  * ib_create_ah_from_wc - Creates an address handle associated with the
1190  *   sender of the specified work completion.
1191  * @pd: The protection domain associated with the address handle.
1192  * @wc: Work completion information associated with a received message.
1193  * @grh: References the received global route header.  This parameter is
1194  *   ignored unless the work completion indicates that the GRH is valid.
1195  * @port_num: The outbound port number to associate with the address.
1196  *
1197  * The address handle is used to reference a local or global destination
1198  * in all UD QP post sends.
1199  */
1200 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1201                                    struct ib_grh *grh, u8 port_num);
1202
1203 /**
1204  * ib_modify_ah - Modifies the address vector associated with an address
1205  *   handle.
1206  * @ah: The address handle to modify.
1207  * @ah_attr: The new address vector attributes to associate with the
1208  *   address handle.
1209  */
1210 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1211
1212 /**
1213  * ib_query_ah - Queries the address vector associated with an address
1214  *   handle.
1215  * @ah: The address handle to query.
1216  * @ah_attr: The address vector attributes associated with the address
1217  *   handle.
1218  */
1219 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1220
1221 /**
1222  * ib_destroy_ah - Destroys an address handle.
1223  * @ah: The address handle to destroy.
1224  */
1225 int ib_destroy_ah(struct ib_ah *ah);
1226
1227 /**
1228  * ib_create_srq - Creates a SRQ associated with the specified protection
1229  *   domain.
1230  * @pd: The protection domain associated with the SRQ.
1231  * @srq_init_attr: A list of initial attributes required to create the
1232  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
1233  *   the actual capabilities of the created SRQ.
1234  *
1235  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1236  * requested size of the SRQ, and set to the actual values allocated
1237  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
1238  * will always be at least as large as the requested values.
1239  */
1240 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1241                              struct ib_srq_init_attr *srq_init_attr);
1242
1243 /**
1244  * ib_modify_srq - Modifies the attributes for the specified SRQ.
1245  * @srq: The SRQ to modify.
1246  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
1247  *   the current values of selected SRQ attributes are returned.
1248  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1249  *   are being modified.
1250  *
1251  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1252  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1253  * the number of receives queued drops below the limit.
1254  */
1255 int ib_modify_srq(struct ib_srq *srq,
1256                   struct ib_srq_attr *srq_attr,
1257                   enum ib_srq_attr_mask srq_attr_mask);
1258
1259 /**
1260  * ib_query_srq - Returns the attribute list and current values for the
1261  *   specified SRQ.
1262  * @srq: The SRQ to query.
1263  * @srq_attr: The attributes of the specified SRQ.
1264  */
1265 int ib_query_srq(struct ib_srq *srq,
1266                  struct ib_srq_attr *srq_attr);
1267
1268 /**
1269  * ib_destroy_srq - Destroys the specified SRQ.
1270  * @srq: The SRQ to destroy.
1271  */
1272 int ib_destroy_srq(struct ib_srq *srq);
1273
1274 /**
1275  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1276  * @srq: The SRQ to post the work request on.
1277  * @recv_wr: A list of work requests to post on the receive queue.
1278  * @bad_recv_wr: On an immediate failure, this parameter will reference
1279  *   the work request that failed to be posted on the QP.
1280  */
1281 static inline int ib_post_srq_recv(struct ib_srq *srq,
1282                                    struct ib_recv_wr *recv_wr,
1283                                    struct ib_recv_wr **bad_recv_wr)
1284 {
1285         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1286 }
1287
1288 /**
1289  * ib_create_qp - Creates a QP associated with the specified protection
1290  *   domain.
1291  * @pd: The protection domain associated with the QP.
1292  * @qp_init_attr: A list of initial attributes required to create the
1293  *   QP.  If QP creation succeeds, then the attributes are updated to
1294  *   the actual capabilities of the created QP.
1295  */
1296 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1297                            struct ib_qp_init_attr *qp_init_attr);
1298
1299 /**
1300  * ib_modify_qp - Modifies the attributes for the specified QP and then
1301  *   transitions the QP to the given state.
1302  * @qp: The QP to modify.
1303  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1304  *   the current values of selected QP attributes are returned.
1305  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1306  *   are being modified.
1307  */
1308 int ib_modify_qp(struct ib_qp *qp,
1309                  struct ib_qp_attr *qp_attr,
1310                  int qp_attr_mask);
1311
1312 /**
1313  * ib_query_qp - Returns the attribute list and current values for the
1314  *   specified QP.
1315  * @qp: The QP to query.
1316  * @qp_attr: The attributes of the specified QP.
1317  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1318  * @qp_init_attr: Additional attributes of the selected QP.
1319  *
1320  * The qp_attr_mask may be used to limit the query to gathering only the
1321  * selected attributes.
1322  */
1323 int ib_query_qp(struct ib_qp *qp,
1324                 struct ib_qp_attr *qp_attr,
1325                 int qp_attr_mask,
1326                 struct ib_qp_init_attr *qp_init_attr);
1327
1328 /**
1329  * ib_destroy_qp - Destroys the specified QP.
1330  * @qp: The QP to destroy.
1331  */
1332 int ib_destroy_qp(struct ib_qp *qp);
1333
1334 /**
1335  * ib_post_send - Posts a list of work requests to the send queue of
1336  *   the specified QP.
1337  * @qp: The QP to post the work request on.
1338  * @send_wr: A list of work requests to post on the send queue.
1339  * @bad_send_wr: On an immediate failure, this parameter will reference
1340  *   the work request that failed to be posted on the QP.
1341  */
1342 static inline int ib_post_send(struct ib_qp *qp,
1343                                struct ib_send_wr *send_wr,
1344                                struct ib_send_wr **bad_send_wr)
1345 {
1346         return qp->device->post_send(qp, send_wr, bad_send_wr);
1347 }
1348
1349 /**
1350  * ib_post_recv - Posts a list of work requests to the receive queue of
1351  *   the specified QP.
1352  * @qp: The QP to post the work request on.
1353  * @recv_wr: A list of work requests to post on the receive queue.
1354  * @bad_recv_wr: On an immediate failure, this parameter will reference
1355  *   the work request that failed to be posted on the QP.
1356  */
1357 static inline int ib_post_recv(struct ib_qp *qp,
1358                                struct ib_recv_wr *recv_wr,
1359                                struct ib_recv_wr **bad_recv_wr)
1360 {
1361         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1362 }
1363
1364 /**
1365  * ib_create_cq - Creates a CQ on the specified device.
1366  * @device: The device on which to create the CQ.
1367  * @comp_handler: A user-specified callback that is invoked when a
1368  *   completion event occurs on the CQ.
1369  * @event_handler: A user-specified callback that is invoked when an
1370  *   asynchronous event not associated with a completion occurs on the CQ.
1371  * @cq_context: Context associated with the CQ returned to the user via
1372  *   the associated completion and event handlers.
1373  * @cqe: The minimum size of the CQ.
1374  * @comp_vector - Completion vector used to signal completion events.
1375  *     Must be >= 0 and < context->num_comp_vectors.
1376  *
1377  * Users can examine the cq structure to determine the actual CQ size.
1378  */
1379 struct ib_cq *ib_create_cq(struct ib_device *device,
1380                            ib_comp_handler comp_handler,
1381                            void (*event_handler)(struct ib_event *, void *),
1382                            void *cq_context, int cqe, int comp_vector);
1383
1384 /**
1385  * ib_resize_cq - Modifies the capacity of the CQ.
1386  * @cq: The CQ to resize.
1387  * @cqe: The minimum size of the CQ.
1388  *
1389  * Users can examine the cq structure to determine the actual CQ size.
1390  */
1391 int ib_resize_cq(struct ib_cq *cq, int cqe);
1392
1393 /**
1394  * ib_modify_cq - Modifies moderation params of the CQ
1395  * @cq: The CQ to modify.
1396  * @cq_count: number of CQEs that will trigger an event
1397  * @cq_period: max period of time in usec before triggering an event
1398  *
1399  */
1400 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1401
1402 /**
1403  * ib_destroy_cq - Destroys the specified CQ.
1404  * @cq: The CQ to destroy.
1405  */
1406 int ib_destroy_cq(struct ib_cq *cq);
1407
1408 /**
1409  * ib_poll_cq - poll a CQ for completion(s)
1410  * @cq:the CQ being polled
1411  * @num_entries:maximum number of completions to return
1412  * @wc:array of at least @num_entries &struct ib_wc where completions
1413  *   will be returned
1414  *
1415  * Poll a CQ for (possibly multiple) completions.  If the return value
1416  * is < 0, an error occurred.  If the return value is >= 0, it is the
1417  * number of completions returned.  If the return value is
1418  * non-negative and < num_entries, then the CQ was emptied.
1419  */
1420 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1421                              struct ib_wc *wc)
1422 {
1423         return cq->device->poll_cq(cq, num_entries, wc);
1424 }
1425
1426 /**
1427  * ib_peek_cq - Returns the number of unreaped completions currently
1428  *   on the specified CQ.
1429  * @cq: The CQ to peek.
1430  * @wc_cnt: A minimum number of unreaped completions to check for.
1431  *
1432  * If the number of unreaped completions is greater than or equal to wc_cnt,
1433  * this function returns wc_cnt, otherwise, it returns the actual number of
1434  * unreaped completions.
1435  */
1436 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1437
1438 /**
1439  * ib_req_notify_cq - Request completion notification on a CQ.
1440  * @cq: The CQ to generate an event for.
1441  * @flags:
1442  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1443  *   to request an event on the next solicited event or next work
1444  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1445  *   may also be |ed in to request a hint about missed events, as
1446  *   described below.
1447  *
1448  * Return Value:
1449  *    < 0 means an error occurred while requesting notification
1450  *   == 0 means notification was requested successfully, and if
1451  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1452  *        were missed and it is safe to wait for another event.  In
1453  *        this case is it guaranteed that any work completions added
1454  *        to the CQ since the last CQ poll will trigger a completion
1455  *        notification event.
1456  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1457  *        in.  It means that the consumer must poll the CQ again to
1458  *        make sure it is empty to avoid missing an event because of a
1459  *        race between requesting notification and an entry being
1460  *        added to the CQ.  This return value means it is possible
1461  *        (but not guaranteed) that a work completion has been added
1462  *        to the CQ since the last poll without triggering a
1463  *        completion notification event.
1464  */
1465 static inline int ib_req_notify_cq(struct ib_cq *cq,
1466                                    enum ib_cq_notify_flags flags)
1467 {
1468         return cq->device->req_notify_cq(cq, flags);
1469 }
1470
1471 /**
1472  * ib_req_ncomp_notif - Request completion notification when there are
1473  *   at least the specified number of unreaped completions on the CQ.
1474  * @cq: The CQ to generate an event for.
1475  * @wc_cnt: The number of unreaped completions that should be on the
1476  *   CQ before an event is generated.
1477  */
1478 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1479 {
1480         return cq->device->req_ncomp_notif ?
1481                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1482                 -ENOSYS;
1483 }
1484
1485 /**
1486  * ib_get_dma_mr - Returns a memory region for system memory that is
1487  *   usable for DMA.
1488  * @pd: The protection domain associated with the memory region.
1489  * @mr_access_flags: Specifies the memory access rights.
1490  *
1491  * Note that the ib_dma_*() functions defined below must be used
1492  * to create/destroy addresses used with the Lkey or Rkey returned
1493  * by ib_get_dma_mr().
1494  */
1495 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1496
1497 /**
1498  * ib_dma_mapping_error - check a DMA addr for error
1499  * @dev: The device for which the dma_addr was created
1500  * @dma_addr: The DMA address to check
1501  */
1502 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1503 {
1504         if (dev->dma_ops)
1505                 return dev->dma_ops->mapping_error(dev, dma_addr);
1506         return dma_mapping_error(dma_addr);
1507 }
1508
1509 /**
1510  * ib_dma_map_single - Map a kernel virtual address to DMA address
1511  * @dev: The device for which the dma_addr is to be created
1512  * @cpu_addr: The kernel virtual address
1513  * @size: The size of the region in bytes
1514  * @direction: The direction of the DMA
1515  */
1516 static inline u64 ib_dma_map_single(struct ib_device *dev,
1517                                     void *cpu_addr, size_t size,
1518                                     enum dma_data_direction direction)
1519 {
1520         if (dev->dma_ops)
1521                 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1522         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1523 }
1524
1525 /**
1526  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1527  * @dev: The device for which the DMA address was created
1528  * @addr: The DMA address
1529  * @size: The size of the region in bytes
1530  * @direction: The direction of the DMA
1531  */
1532 static inline void ib_dma_unmap_single(struct ib_device *dev,
1533                                        u64 addr, size_t size,
1534                                        enum dma_data_direction direction)
1535 {
1536         if (dev->dma_ops)
1537                 dev->dma_ops->unmap_single(dev, addr, size, direction);
1538         else
1539                 dma_unmap_single(dev->dma_device, addr, size, direction);
1540 }
1541
1542 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1543                                           void *cpu_addr, size_t size,
1544                                           enum dma_data_direction direction,
1545                                           struct dma_attrs *attrs)
1546 {
1547         return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1548                                     direction, attrs);
1549 }
1550
1551 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1552                                              u64 addr, size_t size,
1553                                              enum dma_data_direction direction,
1554                                              struct dma_attrs *attrs)
1555 {
1556         return dma_unmap_single_attrs(dev->dma_device, addr, size,
1557                                       direction, attrs);
1558 }
1559
1560 /**
1561  * ib_dma_map_page - Map a physical page to DMA address
1562  * @dev: The device for which the dma_addr is to be created
1563  * @page: The page to be mapped
1564  * @offset: The offset within the page
1565  * @size: The size of the region in bytes
1566  * @direction: The direction of the DMA
1567  */
1568 static inline u64 ib_dma_map_page(struct ib_device *dev,
1569                                   struct page *page,
1570                                   unsigned long offset,
1571                                   size_t size,
1572                                          enum dma_data_direction direction)
1573 {
1574         if (dev->dma_ops)
1575                 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1576         return dma_map_page(dev->dma_device, page, offset, size, direction);
1577 }
1578
1579 /**
1580  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1581  * @dev: The device for which the DMA address was created
1582  * @addr: The DMA address
1583  * @size: The size of the region in bytes
1584  * @direction: The direction of the DMA
1585  */
1586 static inline void ib_dma_unmap_page(struct ib_device *dev,
1587                                      u64 addr, size_t size,
1588                                      enum dma_data_direction direction)
1589 {
1590         if (dev->dma_ops)
1591                 dev->dma_ops->unmap_page(dev, addr, size, direction);
1592         else
1593                 dma_unmap_page(dev->dma_device, addr, size, direction);
1594 }
1595
1596 /**
1597  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1598  * @dev: The device for which the DMA addresses are to be created
1599  * @sg: The array of scatter/gather entries
1600  * @nents: The number of scatter/gather entries
1601  * @direction: The direction of the DMA
1602  */
1603 static inline int ib_dma_map_sg(struct ib_device *dev,
1604                                 struct scatterlist *sg, int nents,
1605                                 enum dma_data_direction direction)
1606 {
1607         if (dev->dma_ops)
1608                 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1609         return dma_map_sg(dev->dma_device, sg, nents, direction);
1610 }
1611
1612 /**
1613  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1614  * @dev: The device for which the DMA addresses were created
1615  * @sg: The array of scatter/gather entries
1616  * @nents: The number of scatter/gather entries
1617  * @direction: The direction of the DMA
1618  */
1619 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1620                                    struct scatterlist *sg, int nents,
1621                                    enum dma_data_direction direction)
1622 {
1623         if (dev->dma_ops)
1624                 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1625         else
1626                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1627 }
1628
1629 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1630                                       struct scatterlist *sg, int nents,
1631                                       enum dma_data_direction direction,
1632                                       struct dma_attrs *attrs)
1633 {
1634         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1635 }
1636
1637 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1638                                          struct scatterlist *sg, int nents,
1639                                          enum dma_data_direction direction,
1640                                          struct dma_attrs *attrs)
1641 {
1642         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1643 }
1644 /**
1645  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1646  * @dev: The device for which the DMA addresses were created
1647  * @sg: The scatter/gather entry
1648  */
1649 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1650                                     struct scatterlist *sg)
1651 {
1652         if (dev->dma_ops)
1653                 return dev->dma_ops->dma_address(dev, sg);
1654         return sg_dma_address(sg);
1655 }
1656
1657 /**
1658  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1659  * @dev: The device for which the DMA addresses were created
1660  * @sg: The scatter/gather entry
1661  */
1662 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1663                                          struct scatterlist *sg)
1664 {
1665         if (dev->dma_ops)
1666                 return dev->dma_ops->dma_len(dev, sg);
1667         return sg_dma_len(sg);
1668 }
1669
1670 /**
1671  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1672  * @dev: The device for which the DMA address was created
1673  * @addr: The DMA address
1674  * @size: The size of the region in bytes
1675  * @dir: The direction of the DMA
1676  */
1677 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1678                                               u64 addr,
1679                                               size_t size,
1680                                               enum dma_data_direction dir)
1681 {
1682         if (dev->dma_ops)
1683                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1684         else
1685                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1686 }
1687
1688 /**
1689  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1690  * @dev: The device for which the DMA address was created
1691  * @addr: The DMA address
1692  * @size: The size of the region in bytes
1693  * @dir: The direction of the DMA
1694  */
1695 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1696                                                  u64 addr,
1697                                                  size_t size,
1698                                                  enum dma_data_direction dir)
1699 {
1700         if (dev->dma_ops)
1701                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1702         else
1703                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1704 }
1705
1706 /**
1707  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1708  * @dev: The device for which the DMA address is requested
1709  * @size: The size of the region to allocate in bytes
1710  * @dma_handle: A pointer for returning the DMA address of the region
1711  * @flag: memory allocator flags
1712  */
1713 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1714                                            size_t size,
1715                                            u64 *dma_handle,
1716                                            gfp_t flag)
1717 {
1718         if (dev->dma_ops)
1719                 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1720         else {
1721                 dma_addr_t handle;
1722                 void *ret;
1723
1724                 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1725                 *dma_handle = handle;
1726                 return ret;
1727         }
1728 }
1729
1730 /**
1731  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1732  * @dev: The device for which the DMA addresses were allocated
1733  * @size: The size of the region
1734  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1735  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1736  */
1737 static inline void ib_dma_free_coherent(struct ib_device *dev,
1738                                         size_t size, void *cpu_addr,
1739                                         u64 dma_handle)
1740 {
1741         if (dev->dma_ops)
1742                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1743         else
1744                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1745 }
1746
1747 /**
1748  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1749  *   by an HCA.
1750  * @pd: The protection domain associated assigned to the registered region.
1751  * @phys_buf_array: Specifies a list of physical buffers to use in the
1752  *   memory region.
1753  * @num_phys_buf: Specifies the size of the phys_buf_array.
1754  * @mr_access_flags: Specifies the memory access rights.
1755  * @iova_start: The offset of the region's starting I/O virtual address.
1756  */
1757 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1758                              struct ib_phys_buf *phys_buf_array,
1759                              int num_phys_buf,
1760                              int mr_access_flags,
1761                              u64 *iova_start);
1762
1763 /**
1764  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1765  *   Conceptually, this call performs the functions deregister memory region
1766  *   followed by register physical memory region.  Where possible,
1767  *   resources are reused instead of deallocated and reallocated.
1768  * @mr: The memory region to modify.
1769  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1770  *   properties of the memory region are being modified.
1771  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1772  *   the new protection domain to associated with the memory region,
1773  *   otherwise, this parameter is ignored.
1774  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1775  *   field specifies a list of physical buffers to use in the new
1776  *   translation, otherwise, this parameter is ignored.
1777  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1778  *   field specifies the size of the phys_buf_array, otherwise, this
1779  *   parameter is ignored.
1780  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1781  *   field specifies the new memory access rights, otherwise, this
1782  *   parameter is ignored.
1783  * @iova_start: The offset of the region's starting I/O virtual address.
1784  */
1785 int ib_rereg_phys_mr(struct ib_mr *mr,
1786                      int mr_rereg_mask,
1787                      struct ib_pd *pd,
1788                      struct ib_phys_buf *phys_buf_array,
1789                      int num_phys_buf,
1790                      int mr_access_flags,
1791                      u64 *iova_start);
1792
1793 /**
1794  * ib_query_mr - Retrieves information about a specific memory region.
1795  * @mr: The memory region to retrieve information about.
1796  * @mr_attr: The attributes of the specified memory region.
1797  */
1798 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1799
1800 /**
1801  * ib_dereg_mr - Deregisters a memory region and removes it from the
1802  *   HCA translation table.
1803  * @mr: The memory region to deregister.
1804  */
1805 int ib_dereg_mr(struct ib_mr *mr);
1806
1807 /**
1808  * ib_alloc_mw - Allocates a memory window.
1809  * @pd: The protection domain associated with the memory window.
1810  */
1811 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1812
1813 /**
1814  * ib_bind_mw - Posts a work request to the send queue of the specified
1815  *   QP, which binds the memory window to the given address range and
1816  *   remote access attributes.
1817  * @qp: QP to post the bind work request on.
1818  * @mw: The memory window to bind.
1819  * @mw_bind: Specifies information about the memory window, including
1820  *   its address range, remote access rights, and associated memory region.
1821  */
1822 static inline int ib_bind_mw(struct ib_qp *qp,
1823                              struct ib_mw *mw,
1824                              struct ib_mw_bind *mw_bind)
1825 {
1826         /* XXX reference counting in corresponding MR? */
1827         return mw->device->bind_mw ?
1828                 mw->device->bind_mw(qp, mw, mw_bind) :
1829                 -ENOSYS;
1830 }
1831
1832 /**
1833  * ib_dealloc_mw - Deallocates a memory window.
1834  * @mw: The memory window to deallocate.
1835  */
1836 int ib_dealloc_mw(struct ib_mw *mw);
1837
1838 /**
1839  * ib_alloc_fmr - Allocates a unmapped fast memory region.
1840  * @pd: The protection domain associated with the unmapped region.
1841  * @mr_access_flags: Specifies the memory access rights.
1842  * @fmr_attr: Attributes of the unmapped region.
1843  *
1844  * A fast memory region must be mapped before it can be used as part of
1845  * a work request.
1846  */
1847 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1848                             int mr_access_flags,
1849                             struct ib_fmr_attr *fmr_attr);
1850
1851 /**
1852  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1853  * @fmr: The fast memory region to associate with the pages.
1854  * @page_list: An array of physical pages to map to the fast memory region.
1855  * @list_len: The number of pages in page_list.
1856  * @iova: The I/O virtual address to use with the mapped region.
1857  */
1858 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1859                                   u64 *page_list, int list_len,
1860                                   u64 iova)
1861 {
1862         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1863 }
1864
1865 /**
1866  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1867  * @fmr_list: A linked list of fast memory regions to unmap.
1868  */
1869 int ib_unmap_fmr(struct list_head *fmr_list);
1870
1871 /**
1872  * ib_dealloc_fmr - Deallocates a fast memory region.
1873  * @fmr: The fast memory region to deallocate.
1874  */
1875 int ib_dealloc_fmr(struct ib_fmr *fmr);
1876
1877 /**
1878  * ib_attach_mcast - Attaches the specified QP to a multicast group.
1879  * @qp: QP to attach to the multicast group.  The QP must be type
1880  *   IB_QPT_UD.
1881  * @gid: Multicast group GID.
1882  * @lid: Multicast group LID in host byte order.
1883  *
1884  * In order to send and receive multicast packets, subnet
1885  * administration must have created the multicast group and configured
1886  * the fabric appropriately.  The port associated with the specified
1887  * QP must also be a member of the multicast group.
1888  */
1889 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1890
1891 /**
1892  * ib_detach_mcast - Detaches the specified QP from a multicast group.
1893  * @qp: QP to detach from the multicast group.
1894  * @gid: Multicast group GID.
1895  * @lid: Multicast group LID in host byte order.
1896  */
1897 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1898
1899 #endif /* IB_VERBS_H */