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