drivers/infiniband/include/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 Cisco Systems.  All rights reserved.
   8  *
   9  * This software is available to you under a choice of one of two
  10  * licenses.  You may choose to be licensed under the terms of the GNU
  11  * General Public License (GPL) Version 2, available from the file
  12  * COPYING in the main directory of this source tree, or the
  13  * OpenIB.org BSD license below:
  14  *
  15  *     Redistribution and use in source and binary forms, with or
  16  *     without modification, are permitted provided that the following
  17  *     conditions are met:
  18  *
  19  *      - Redistributions of source code must retain the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer.
  22  *
  23  *      - Redistributions in binary form must reproduce the above
  24  *        copyright notice, this list of conditions and the following
  25  *        disclaimer in the documentation and/or other materials
  26  *        provided with the distribution.
  27  *
  28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  29  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  31  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  32  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  33  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  34  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  35  * SOFTWARE.
  36  *
  37  * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
  38  */
  39
  40 #if !defined(IB_VERBS_H)
  41 #define IB_VERBS_H
  42
  43 #include <linux/types.h>
  44 #include <linux/device.h>
  45
  46 #include <asm/atomic.h>
  47 #include <asm/scatterlist.h>
  48 #include <asm/uaccess.h>
  49
  50 union ib_gid {
  51         u8      raw[16];
  52         struct {
  53                 u64     subnet_prefix;
  54                 u64     interface_id;
  55         } global;
  56 };
  57
  58 enum ib_node_type {
  59         IB_NODE_CA      = 1,
  60         IB_NODE_SWITCH,
  61         IB_NODE_ROUTER
  62 };
  63
  64 enum ib_device_cap_flags {
  65         IB_DEVICE_RESIZE_MAX_WR         = 1,
  66         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
  67         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
  68         IB_DEVICE_RAW_MULTI             = (1<<3),
  69         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
  70         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
  71         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
  72         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
  73         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
  74         IB_DEVICE_INIT_TYPE             = (1<<9),
  75         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
  76         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
  77         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
  78         IB_DEVICE_SRQ_RESIZE            = (1<<13),
  79         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
  80 };
  81
  82 enum ib_atomic_cap {
  83         IB_ATOMIC_NONE,
  84         IB_ATOMIC_HCA,
  85         IB_ATOMIC_GLOB
  86 };
  87
  88 struct ib_device_attr {
  89         u64                     fw_ver;
  90         u64                     node_guid;
  91         u64                     sys_image_guid;
  92         u64                     max_mr_size;
  93         u64                     page_size_cap;
  94         u32                     vendor_id;
  95         u32                     vendor_part_id;
  96         u32                     hw_ver;
  97         int                     max_qp;
  98         int                     max_qp_wr;
  99         int                     device_cap_flags;
 100         int                     max_sge;
 101         int                     max_sge_rd;
 102         int                     max_cq;
 103         int                     max_cqe;
 104         int                     max_mr;
 105         int                     max_pd;
 106         int                     max_qp_rd_atom;
 107         int                     max_ee_rd_atom;
 108         int                     max_res_rd_atom;
 109         int                     max_qp_init_rd_atom;
 110         int                     max_ee_init_rd_atom;
 111         enum ib_atomic_cap      atomic_cap;
 112         int                     max_ee;
 113         int                     max_rdd;
 114         int                     max_mw;
 115         int                     max_raw_ipv6_qp;
 116         int                     max_raw_ethy_qp;
 117         int                     max_mcast_grp;
 118         int                     max_mcast_qp_attach;
 119         int                     max_total_mcast_qp_attach;
 120         int                     max_ah;
 121         int                     max_fmr;
 122         int                     max_map_per_fmr;
 123         int                     max_srq;
 124         int                     max_srq_wr;
 125         int                     max_srq_sge;
 126         u16                     max_pkeys;
 127         u8                      local_ca_ack_delay;
 128 };
 129
 130 enum ib_mtu {
 131         IB_MTU_256  = 1,
 132         IB_MTU_512  = 2,
 133         IB_MTU_1024 = 3,
 134         IB_MTU_2048 = 4,
 135         IB_MTU_4096 = 5
 136 };
 137
 138 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 139 {
 140         switch (mtu) {
 141         case IB_MTU_256:  return  256;
 142         case IB_MTU_512:  return  512;
 143         case IB_MTU_1024: return 1024;
 144         case IB_MTU_2048: return 2048;
 145         case IB_MTU_4096: return 4096;
 146         default:          return -1;
 147         }
 148 }
 149
 150 enum ib_port_state {
 151         IB_PORT_NOP             = 0,
 152         IB_PORT_DOWN            = 1,
 153         IB_PORT_INIT            = 2,
 154         IB_PORT_ARMED           = 3,
 155         IB_PORT_ACTIVE          = 4,
 156         IB_PORT_ACTIVE_DEFER    = 5
 157 };
 158
 159 enum ib_port_cap_flags {
 160         IB_PORT_SM                              = 1 <<  1,
 161         IB_PORT_NOTICE_SUP                      = 1 <<  2,
 162         IB_PORT_TRAP_SUP                        = 1 <<  3,
 163         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
 164         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
 165         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
 166         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
 167         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
 168         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
 169         IB_PORT_SM_DISABLED                     = 1 << 10,
 170         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
 171         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
 172         IB_PORT_CM_SUP                          = 1 << 16,
 173         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
 174         IB_PORT_REINIT_SUP                      = 1 << 18,
 175         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
 176         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
 177         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
 178         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
 179         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
 180         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
 181         IB_PORT_CLIENT_REG_SUP                  = 1 << 25
 182 };
 183
 184 enum ib_port_width {
 185         IB_WIDTH_1X     = 1,
 186         IB_WIDTH_4X     = 2,
 187         IB_WIDTH_8X     = 4,
 188         IB_WIDTH_12X    = 8
 189 };
 190
 191 static inline int ib_width_enum_to_int(enum ib_port_width width)
 192 {
 193         switch (width) {
 194         case IB_WIDTH_1X:  return  1;
 195         case IB_WIDTH_4X:  return  4;
 196         case IB_WIDTH_8X:  return  8;
 197         case IB_WIDTH_12X: return 12;
 198         default:          return -1;
 199         }
 200 }
 201
 202 struct ib_port_attr {
 203         enum ib_port_state      state;
 204         enum ib_mtu             max_mtu;
 205         enum ib_mtu             active_mtu;
 206         int                     gid_tbl_len;
 207         u32                     port_cap_flags;
 208         u32                     max_msg_sz;
 209         u32                     bad_pkey_cntr;
 210         u32                     qkey_viol_cntr;
 211         u16                     pkey_tbl_len;
 212         u16                     lid;
 213         u16                     sm_lid;
 214         u8                      lmc;
 215         u8                      max_vl_num;
 216         u8                      sm_sl;
 217         u8                      subnet_timeout;
 218         u8                      init_type_reply;
 219         u8                      active_width;
 220         u8                      active_speed;
 221         u8                      phys_state;
 222 };
 223
 224 enum ib_device_modify_flags {
 225         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1
 226 };
 227
 228 struct ib_device_modify {
 229         u64     sys_image_guid;
 230 };
 231
 232 enum ib_port_modify_flags {
 233         IB_PORT_SHUTDOWN                = 1,
 234         IB_PORT_INIT_TYPE               = (1<<2),
 235         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
 236 };
 237
 238 struct ib_port_modify {
 239         u32     set_port_cap_mask;
 240         u32     clr_port_cap_mask;
 241         u8      init_type;
 242 };
 243
 244 enum ib_event_type {
 245         IB_EVENT_CQ_ERR,
 246         IB_EVENT_QP_FATAL,
 247         IB_EVENT_QP_REQ_ERR,
 248         IB_EVENT_QP_ACCESS_ERR,
 249         IB_EVENT_COMM_EST,
 250         IB_EVENT_SQ_DRAINED,
 251         IB_EVENT_PATH_MIG,
 252         IB_EVENT_PATH_MIG_ERR,
 253         IB_EVENT_DEVICE_FATAL,
 254         IB_EVENT_PORT_ACTIVE,
 255         IB_EVENT_PORT_ERR,
 256         IB_EVENT_LID_CHANGE,
 257         IB_EVENT_PKEY_CHANGE,
 258         IB_EVENT_SM_CHANGE
 259 };
 260
 261 struct ib_event {
 262         struct ib_device        *device;
 263         union {
 264                 struct ib_cq    *cq;
 265                 struct ib_qp    *qp;
 266                 u8              port_num;
 267         } element;
 268         enum ib_event_type      event;
 269 };
 270
 271 struct ib_event_handler {
 272         struct ib_device *device;
 273         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 274         struct list_head  list;
 275 };
 276
 277 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 278         do {                                                    \
 279                 (_ptr)->device  = _device;                      \
 280                 (_ptr)->handler = _handler;                     \
 281                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 282         } while (0)
 283
 284 struct ib_global_route {
 285         union ib_gid    dgid;
 286         u32             flow_label;
 287         u8              sgid_index;
 288         u8              hop_limit;
 289         u8              traffic_class;
 290 };
 291
 292 struct ib_grh {
 293         u32             version_tclass_flow;
 294         u16             paylen;
 295         u8              next_hdr;
 296         u8              hop_limit;
 297         union ib_gid    sgid;
 298         union ib_gid    dgid;
 299 };
 300
 301 enum {
 302         IB_MULTICAST_QPN = 0xffffff
 303 };
 304
 305 enum ib_ah_flags {
 306         IB_AH_GRH       = 1
 307 };
 308
 309 struct ib_ah_attr {
 310         struct ib_global_route  grh;
 311         u16                     dlid;
 312         u8                      sl;
 313         u8                      src_path_bits;
 314         u8                      static_rate;
 315         u8                      ah_flags;
 316         u8                      port_num;
 317 };
 318
 319 enum ib_wc_status {
 320         IB_WC_SUCCESS,
 321         IB_WC_LOC_LEN_ERR,
 322         IB_WC_LOC_QP_OP_ERR,
 323         IB_WC_LOC_EEC_OP_ERR,
 324         IB_WC_LOC_PROT_ERR,
 325         IB_WC_WR_FLUSH_ERR,
 326         IB_WC_MW_BIND_ERR,
 327         IB_WC_BAD_RESP_ERR,
 328         IB_WC_LOC_ACCESS_ERR,
 329         IB_WC_REM_INV_REQ_ERR,
 330         IB_WC_REM_ACCESS_ERR,
 331         IB_WC_REM_OP_ERR,
 332         IB_WC_RETRY_EXC_ERR,
 333         IB_WC_RNR_RETRY_EXC_ERR,
 334         IB_WC_LOC_RDD_VIOL_ERR,
 335         IB_WC_REM_INV_RD_REQ_ERR,
 336         IB_WC_REM_ABORT_ERR,
 337         IB_WC_INV_EECN_ERR,
 338         IB_WC_INV_EEC_STATE_ERR,
 339         IB_WC_FATAL_ERR,
 340         IB_WC_RESP_TIMEOUT_ERR,
 341         IB_WC_GENERAL_ERR
 342 };
 343
 344 enum ib_wc_opcode {
 345         IB_WC_SEND,
 346         IB_WC_RDMA_WRITE,
 347         IB_WC_RDMA_READ,
 348         IB_WC_COMP_SWAP,
 349         IB_WC_FETCH_ADD,
 350         IB_WC_BIND_MW,
 351 /*
 352  * Set value of IB_WC_RECV so consumers can test if a completion is a
 353  * receive by testing (opcode & IB_WC_RECV).
 354  */
 355         IB_WC_RECV                      = 1 << 7,
 356         IB_WC_RECV_RDMA_WITH_IMM
 357 };
 358
 359 enum ib_wc_flags {
 360         IB_WC_GRH               = 1,
 361         IB_WC_WITH_IMM          = (1<<1)
 362 };
 363
 364 struct ib_wc {
 365         u64                     wr_id;
 366         enum ib_wc_status       status;
 367         enum ib_wc_opcode       opcode;
 368         u32                     vendor_err;
 369         u32                     byte_len;
 370         __be32                  imm_data;
 371         u32                     qp_num;
 372         u32                     src_qp;
 373         int                     wc_flags;
 374         u16                     pkey_index;
 375         u16                     slid;
 376         u8                      sl;
 377         u8                      dlid_path_bits;
 378         u8                      port_num;       /* valid only for DR SMPs on switches */
 379 };
 380
 381 enum ib_cq_notify {
 382         IB_CQ_SOLICITED,
 383         IB_CQ_NEXT_COMP
 384 };
 385
 386 struct ib_qp_cap {
 387         u32     max_send_wr;
 388         u32     max_recv_wr;
 389         u32     max_send_sge;
 390         u32     max_recv_sge;
 391         u32     max_inline_data;
 392 };
 393
 394 enum ib_sig_type {
 395         IB_SIGNAL_ALL_WR,
 396         IB_SIGNAL_REQ_WR
 397 };
 398
 399 enum ib_qp_type {
 400         /*
 401          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
 402          * here (and in that order) since the MAD layer uses them as
 403          * indices into a 2-entry table.
 404          */
 405         IB_QPT_SMI,
 406         IB_QPT_GSI,
 407
 408         IB_QPT_RC,
 409         IB_QPT_UC,
 410         IB_QPT_UD,
 411         IB_QPT_RAW_IPV6,
 412         IB_QPT_RAW_ETY
 413 };
 414
 415 struct ib_qp_init_attr {
 416         void                  (*event_handler)(struct ib_event *, void *);
 417         void                   *qp_context;
 418         struct ib_cq           *send_cq;
 419         struct ib_cq           *recv_cq;
 420         struct ib_srq          *srq;
 421         struct ib_qp_cap        cap;
 422         enum ib_sig_type        sq_sig_type;
 423         enum ib_qp_type         qp_type;
 424         u8                      port_num; /* special QP types only */
 425 };
 426
 427 enum ib_rnr_timeout {
 428         IB_RNR_TIMER_655_36 =  0,
 429         IB_RNR_TIMER_000_01 =  1,
 430         IB_RNR_TIMER_000_02 =  2,
 431         IB_RNR_TIMER_000_03 =  3,
 432         IB_RNR_TIMER_000_04 =  4,
 433         IB_RNR_TIMER_000_06 =  5,
 434         IB_RNR_TIMER_000_08 =  6,
 435         IB_RNR_TIMER_000_12 =  7,
 436         IB_RNR_TIMER_000_16 =  8,
 437         IB_RNR_TIMER_000_24 =  9,
 438         IB_RNR_TIMER_000_32 = 10,
 439         IB_RNR_TIMER_000_48 = 11,
 440         IB_RNR_TIMER_000_64 = 12,
 441         IB_RNR_TIMER_000_96 = 13,
 442         IB_RNR_TIMER_001_28 = 14,
 443         IB_RNR_TIMER_001_92 = 15,
 444         IB_RNR_TIMER_002_56 = 16,
 445         IB_RNR_TIMER_003_84 = 17,
 446         IB_RNR_TIMER_005_12 = 18,
 447         IB_RNR_TIMER_007_68 = 19,
 448         IB_RNR_TIMER_010_24 = 20,
 449         IB_RNR_TIMER_015_36 = 21,
 450         IB_RNR_TIMER_020_48 = 22,
 451         IB_RNR_TIMER_030_72 = 23,
 452         IB_RNR_TIMER_040_96 = 24,
 453         IB_RNR_TIMER_061_44 = 25,
 454         IB_RNR_TIMER_081_92 = 26,
 455         IB_RNR_TIMER_122_88 = 27,
 456         IB_RNR_TIMER_163_84 = 28,
 457         IB_RNR_TIMER_245_76 = 29,
 458         IB_RNR_TIMER_327_68 = 30,
 459         IB_RNR_TIMER_491_52 = 31
 460 };
 461
 462 enum ib_qp_attr_mask {
 463         IB_QP_STATE                     = 1,
 464         IB_QP_CUR_STATE                 = (1<<1),
 465         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
 466         IB_QP_ACCESS_FLAGS              = (1<<3),
 467         IB_QP_PKEY_INDEX                = (1<<4),
 468         IB_QP_PORT                      = (1<<5),
 469         IB_QP_QKEY                      = (1<<6),
 470         IB_QP_AV                        = (1<<7),
 471         IB_QP_PATH_MTU                  = (1<<8),
 472         IB_QP_TIMEOUT                   = (1<<9),
 473         IB_QP_RETRY_CNT                 = (1<<10),
 474         IB_QP_RNR_RETRY                 = (1<<11),
 475         IB_QP_RQ_PSN                    = (1<<12),
 476         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
 477         IB_QP_ALT_PATH                  = (1<<14),
 478         IB_QP_MIN_RNR_TIMER             = (1<<15),
 479         IB_QP_SQ_PSN                    = (1<<16),
 480         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
 481         IB_QP_PATH_MIG_STATE            = (1<<18),
 482         IB_QP_CAP                       = (1<<19),
 483         IB_QP_DEST_QPN                  = (1<<20)
 484 };
 485
 486 enum ib_qp_state {
 487         IB_QPS_RESET,
 488         IB_QPS_INIT,
 489         IB_QPS_RTR,
 490         IB_QPS_RTS,
 491         IB_QPS_SQD,
 492         IB_QPS_SQE,
 493         IB_QPS_ERR
 494 };
 495
 496 enum ib_mig_state {
 497         IB_MIG_MIGRATED,
 498         IB_MIG_REARM,
 499         IB_MIG_ARMED
 500 };
 501
 502 struct ib_qp_attr {
 503         enum ib_qp_state        qp_state;
 504         enum ib_qp_state        cur_qp_state;
 505         enum ib_mtu             path_mtu;
 506         enum ib_mig_state       path_mig_state;
 507         u32                     qkey;
 508         u32                     rq_psn;
 509         u32                     sq_psn;
 510         u32                     dest_qp_num;
 511         int                     qp_access_flags;
 512         struct ib_qp_cap        cap;
 513         struct ib_ah_attr       ah_attr;
 514         struct ib_ah_attr       alt_ah_attr;
 515         u16                     pkey_index;
 516         u16                     alt_pkey_index;
 517         u8                      en_sqd_async_notify;
 518         u8                      sq_draining;
 519         u8                      max_rd_atomic;
 520         u8                      max_dest_rd_atomic;
 521         u8                      min_rnr_timer;
 522         u8                      port_num;
 523         u8                      timeout;
 524         u8                      retry_cnt;
 525         u8                      rnr_retry;
 526         u8                      alt_port_num;
 527         u8                      alt_timeout;
 528 };
 529
 530 enum ib_wr_opcode {
 531         IB_WR_RDMA_WRITE,
 532         IB_WR_RDMA_WRITE_WITH_IMM,
 533         IB_WR_SEND,
 534         IB_WR_SEND_WITH_IMM,
 535         IB_WR_RDMA_READ,
 536         IB_WR_ATOMIC_CMP_AND_SWP,
 537         IB_WR_ATOMIC_FETCH_AND_ADD
 538 };
 539
 540 enum ib_send_flags {
 541         IB_SEND_FENCE           = 1,
 542         IB_SEND_SIGNALED        = (1<<1),
 543         IB_SEND_SOLICITED       = (1<<2),
 544         IB_SEND_INLINE          = (1<<3)
 545 };
 546
 547 struct ib_sge {
 548         u64     addr;
 549         u32     length;
 550         u32     lkey;
 551 };
 552
 553 struct ib_send_wr {
 554         struct ib_send_wr      *next;
 555         u64                     wr_id;
 556         struct ib_sge          *sg_list;
 557         int                     num_sge;
 558         enum ib_wr_opcode       opcode;
 559         int                     send_flags;
 560         __be32                  imm_data;
 561         union {
 562                 struct {
 563                         u64     remote_addr;
 564                         u32     rkey;
 565                 } rdma;
 566                 struct {
 567                         u64     remote_addr;
 568                         u64     compare_add;
 569                         u64     swap;
 570                         u32     rkey;
 571                 } atomic;
 572                 struct {
 573                         struct ib_ah *ah;
 574                         struct ib_mad_hdr *mad_hdr;
 575                         u32     remote_qpn;
 576                         u32     remote_qkey;
 577                         int     timeout_ms; /* valid for MADs only */
 578                         int     retries;    /* valid for MADs only */
 579                         u16     pkey_index; /* valid for GSI only */
 580                         u8      port_num;   /* valid for DR SMPs on switch only */
 581                 } ud;
 582         } wr;
 583 };
 584
 585 struct ib_recv_wr {
 586         struct ib_recv_wr      *next;
 587         u64                     wr_id;
 588         struct ib_sge          *sg_list;
 589         int                     num_sge;
 590 };
 591
 592 enum ib_access_flags {
 593         IB_ACCESS_LOCAL_WRITE   = 1,
 594         IB_ACCESS_REMOTE_WRITE  = (1<<1),
 595         IB_ACCESS_REMOTE_READ   = (1<<2),
 596         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
 597         IB_ACCESS_MW_BIND       = (1<<4)
 598 };
 599
 600 struct ib_phys_buf {
 601         u64      addr;
 602         u64      size;
 603 };
 604
 605 struct ib_mr_attr {
 606         struct ib_pd    *pd;
 607         u64             device_virt_addr;
 608         u64             size;
 609         int             mr_access_flags;
 610         u32             lkey;
 611         u32             rkey;
 612 };
 613
 614 enum ib_mr_rereg_flags {
 615         IB_MR_REREG_TRANS       = 1,
 616         IB_MR_REREG_PD          = (1<<1),
 617         IB_MR_REREG_ACCESS      = (1<<2)
 618 };
 619
 620 struct ib_mw_bind {
 621         struct ib_mr   *mr;
 622         u64             wr_id;
 623         u64             addr;
 624         u32             length;
 625         int             send_flags;
 626         int             mw_access_flags;
 627 };
 628
 629 struct ib_fmr_attr {
 630         int     max_pages;
 631         int     max_maps;
 632         u8      page_size;
 633 };
 634
 635 struct ib_ucontext {
 636         struct ib_device       *device;
 637         struct list_head        pd_list;
 638         struct list_head        mr_list;
 639         struct list_head        mw_list;
 640         struct list_head        cq_list;
 641         struct list_head        qp_list;
 642         struct list_head        srq_list;
 643         struct list_head        ah_list;
 644         spinlock_t              lock;
 645 };
 646
 647 struct ib_uobject {
 648         u64                     user_handle;    /* handle given to us by userspace */
 649         struct ib_ucontext     *context;        /* associated user context */
 650         struct list_head        list;           /* link to context's list */
 651         u32                     id;             /* index into kernel idr */
 652 };
 653
 654 struct ib_umem {
 655         unsigned long           user_base;
 656         unsigned long           virt_base;
 657         size_t                  length;
 658         int                     offset;
 659         int                     page_size;
 660         int                     writable;
 661         struct list_head        chunk_list;
 662 };
 663
 664 struct ib_umem_chunk {
 665         struct list_head        list;
 666         int                     nents;
 667         int                     nmap;
 668         struct scatterlist      page_list[0];
 669 };
 670
 671 struct ib_udata {
 672         void __user *inbuf;
 673         void __user *outbuf;
 674         size_t       inlen;
 675         size_t       outlen;
 676 };
 677
 678 #define IB_UMEM_MAX_PAGE_CHUNK                                          \
 679         ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) /      \
 680          ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] -        \
 681           (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
 682
 683 struct ib_umem_object {
 684         struct ib_uobject       uobject;
 685         struct ib_umem          umem;
 686 };
 687
 688 struct ib_pd {
 689         struct ib_device       *device;
 690         struct ib_uobject      *uobject;
 691         atomic_t                usecnt; /* count all resources */
 692 };
 693
 694 struct ib_ah {
 695         struct ib_device        *device;
 696         struct ib_pd            *pd;
 697         struct ib_uobject       *uobject;
 698 };
 699
 700 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
 701
 702 struct ib_cq {
 703         struct ib_device       *device;
 704         struct ib_uobject      *uobject;
 705         ib_comp_handler         comp_handler;
 706         void                  (*event_handler)(struct ib_event *, void *);
 707         void *                  cq_context;
 708         int                     cqe;
 709         atomic_t                usecnt; /* count number of work queues */
 710 };
 711
 712 struct ib_srq {
 713         struct ib_device        *device;
 714         struct ib_uobject       *uobject;
 715         struct ib_pd            *pd;
 716         void                    *srq_context;
 717         atomic_t                usecnt;
 718 };
 719
 720 struct ib_qp {
 721         struct ib_device       *device;
 722         struct ib_pd           *pd;
 723         struct ib_cq           *send_cq;
 724         struct ib_cq           *recv_cq;
 725         struct ib_srq          *srq;
 726         struct ib_uobject      *uobject;
 727         void                  (*event_handler)(struct ib_event *, void *);
 728         void                   *qp_context;
 729         u32                     qp_num;
 730         enum ib_qp_type         qp_type;
 731 };
 732
 733 struct ib_mr {
 734         struct ib_device  *device;
 735         struct ib_pd      *pd;
 736         struct ib_uobject *uobject;
 737         u32                lkey;
 738         u32                rkey;
 739         atomic_t           usecnt; /* count number of MWs */
 740 };
 741
 742 struct ib_mw {
 743         struct ib_device        *device;
 744         struct ib_pd            *pd;
 745         struct ib_uobject       *uobject;
 746         u32                     rkey;
 747 };
 748
 749 struct ib_fmr {
 750         struct ib_device        *device;
 751         struct ib_pd            *pd;
 752         struct list_head        list;
 753         u32                     lkey;
 754         u32                     rkey;
 755 };
 756
 757 struct ib_mad;
 758 struct ib_grh;
 759
 760 enum ib_process_mad_flags {
 761         IB_MAD_IGNORE_MKEY      = 1,
 762         IB_MAD_IGNORE_BKEY      = 2,
 763         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
 764 };
 765
 766 enum ib_mad_result {
 767         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
 768         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
 769         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
 770         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
 771 };
 772
 773 #define IB_DEVICE_NAME_MAX 64
 774
 775 struct ib_cache {
 776         rwlock_t                lock;
 777         struct ib_event_handler event_handler;
 778         struct ib_pkey_cache  **pkey_cache;
 779         struct ib_gid_cache   **gid_cache;
 780 };
 781
 782 struct ib_device {
 783         struct device                *dma_device;
 784
 785         char                          name[IB_DEVICE_NAME_MAX];
 786
 787         struct list_head              event_handler_list;
 788         spinlock_t                    event_handler_lock;
 789
 790         struct list_head              core_list;
 791         struct list_head              client_data_list;
 792         spinlock_t                    client_data_lock;
 793
 794         struct ib_cache               cache;
 795
 796         u32                           flags;
 797
 798         int                        (*query_device)(struct ib_device *device,
 799                                                    struct ib_device_attr *device_attr);
 800         int                        (*query_port)(struct ib_device *device,
 801                                                  u8 port_num,
 802                                                  struct ib_port_attr *port_attr);
 803         int                        (*query_gid)(struct ib_device *device,
 804                                                 u8 port_num, int index,
 805                                                 union ib_gid *gid);
 806         int                        (*query_pkey)(struct ib_device *device,
 807                                                  u8 port_num, u16 index, u16 *pkey);
 808         int                        (*modify_device)(struct ib_device *device,
 809                                                     int device_modify_mask,
 810                                                     struct ib_device_modify *device_modify);
 811         int                        (*modify_port)(struct ib_device *device,
 812                                                   u8 port_num, int port_modify_mask,
 813                                                   struct ib_port_modify *port_modify);
 814         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
 815                                                      struct ib_udata *udata);
 816         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
 817         int                        (*mmap)(struct ib_ucontext *context,
 818                                            struct vm_area_struct *vma);
 819         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
 820                                                struct ib_ucontext *context,
 821                                                struct ib_udata *udata);
 822         int                        (*dealloc_pd)(struct ib_pd *pd);
 823         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
 824                                                 struct ib_ah_attr *ah_attr);
 825         int                        (*modify_ah)(struct ib_ah *ah,
 826                                                 struct ib_ah_attr *ah_attr);
 827         int                        (*query_ah)(struct ib_ah *ah,
 828                                                struct ib_ah_attr *ah_attr);
 829         int                        (*destroy_ah)(struct ib_ah *ah);
 830         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
 831                                                 struct ib_qp_init_attr *qp_init_attr,
 832                                                 struct ib_udata *udata);
 833         int                        (*modify_qp)(struct ib_qp *qp,
 834                                                 struct ib_qp_attr *qp_attr,
 835                                                 int qp_attr_mask);
 836         int                        (*query_qp)(struct ib_qp *qp,
 837                                                struct ib_qp_attr *qp_attr,
 838                                                int qp_attr_mask,
 839                                                struct ib_qp_init_attr *qp_init_attr);
 840         int                        (*destroy_qp)(struct ib_qp *qp);
 841         int                        (*post_send)(struct ib_qp *qp,
 842                                                 struct ib_send_wr *send_wr,
 843                                                 struct ib_send_wr **bad_send_wr);
 844         int                        (*post_recv)(struct ib_qp *qp,
 845                                                 struct ib_recv_wr *recv_wr,
 846                                                 struct ib_recv_wr **bad_recv_wr);
 847         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
 848                                                 struct ib_ucontext *context,
 849                                                 struct ib_udata *udata);
 850         int                        (*destroy_cq)(struct ib_cq *cq);
 851         int                        (*resize_cq)(struct ib_cq *cq, int *cqe);
 852         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
 853                                               struct ib_wc *wc);
 854         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
 855         int                        (*req_notify_cq)(struct ib_cq *cq,
 856                                                     enum ib_cq_notify cq_notify);
 857         int                        (*req_ncomp_notif)(struct ib_cq *cq,
 858                                                       int wc_cnt);
 859         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
 860                                                  int mr_access_flags);
 861         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
 862                                                   struct ib_phys_buf *phys_buf_array,
 863                                                   int num_phys_buf,
 864                                                   int mr_access_flags,
 865                                                   u64 *iova_start);
 866         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
 867                                                   struct ib_umem *region,
 868                                                   int mr_access_flags,
 869                                                   struct ib_udata *udata);
 870         int                        (*query_mr)(struct ib_mr *mr,
 871                                                struct ib_mr_attr *mr_attr);
 872         int                        (*dereg_mr)(struct ib_mr *mr);
 873         int                        (*rereg_phys_mr)(struct ib_mr *mr,
 874                                                     int mr_rereg_mask,
 875                                                     struct ib_pd *pd,
 876                                                     struct ib_phys_buf *phys_buf_array,
 877                                                     int num_phys_buf,
 878                                                     int mr_access_flags,
 879                                                     u64 *iova_start);
 880         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
 881         int                        (*bind_mw)(struct ib_qp *qp,
 882                                               struct ib_mw *mw,
 883                                               struct ib_mw_bind *mw_bind);
 884         int                        (*dealloc_mw)(struct ib_mw *mw);
 885         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
 886                                                 int mr_access_flags,
 887                                                 struct ib_fmr_attr *fmr_attr);
 888         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
 889                                                    u64 *page_list, int list_len,
 890                                                    u64 iova);
 891         int                        (*unmap_fmr)(struct list_head *fmr_list);
 892         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
 893         int                        (*attach_mcast)(struct ib_qp *qp,
 894                                                    union ib_gid *gid,
 895                                                    u16 lid);
 896         int                        (*detach_mcast)(struct ib_qp *qp,
 897                                                    union ib_gid *gid,
 898                                                    u16 lid);
 899         int                        (*process_mad)(struct ib_device *device,
 900                                                   int process_mad_flags,
 901                                                   u8 port_num,
 902                                                   struct ib_wc *in_wc,
 903                                                   struct ib_grh *in_grh,
 904                                                   struct ib_mad *in_mad,
 905                                                   struct ib_mad *out_mad);
 906
 907         struct module               *owner;
 908         struct class_device          class_dev;
 909         struct kobject               ports_parent;
 910         struct list_head             port_list;
 911
 912         enum {
 913                 IB_DEV_UNINITIALIZED,
 914                 IB_DEV_REGISTERED,
 915                 IB_DEV_UNREGISTERED
 916         }                            reg_state;
 917
 918         u8                           node_type;
 919         u8                           phys_port_cnt;
 920 };
 921
 922 struct ib_client {
 923         char  *name;
 924         void (*add)   (struct ib_device *);
 925         void (*remove)(struct ib_device *);
 926
 927         struct list_head list;
 928 };
 929
 930 struct ib_device *ib_alloc_device(size_t size);
 931 void ib_dealloc_device(struct ib_device *device);
 932
 933 int ib_register_device   (struct ib_device *device);
 934 void ib_unregister_device(struct ib_device *device);
 935
 936 int ib_register_client   (struct ib_client *client);
 937 void ib_unregister_client(struct ib_client *client);
 938
 939 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
 940 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
 941                          void *data);
 942
 943 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
 944 {
 945         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
 946 }
 947
 948 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
 949 {
 950         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
 951 }
 952
 953 int ib_register_event_handler  (struct ib_event_handler *event_handler);
 954 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
 955 void ib_dispatch_event(struct ib_event *event);
 956
 957 int ib_query_device(struct ib_device *device,
 958                     struct ib_device_attr *device_attr);
 959
 960 int ib_query_port(struct ib_device *device,
 961                   u8 port_num, struct ib_port_attr *port_attr);
 962
 963 int ib_query_gid(struct ib_device *device,
 964                  u8 port_num, int index, union ib_gid *gid);
 965
 966 int ib_query_pkey(struct ib_device *device,
 967                   u8 port_num, u16 index, u16 *pkey);
 968
 969 int ib_modify_device(struct ib_device *device,
 970                      int device_modify_mask,
 971                      struct ib_device_modify *device_modify);
 972
 973 int ib_modify_port(struct ib_device *device,
 974                    u8 port_num, int port_modify_mask,
 975                    struct ib_port_modify *port_modify);
 976
 977 /**
 978  * ib_alloc_pd - Allocates an unused protection domain.
 979  * @device: The device on which to allocate the protection domain.
 980  *
 981  * A protection domain object provides an association between QPs, shared
 982  * receive queues, address handles, memory regions, and memory windows.
 983  */
 984 struct ib_pd *ib_alloc_pd(struct ib_device *device);
 985
 986 /**
 987  * ib_dealloc_pd - Deallocates a protection domain.
 988  * @pd: The protection domain to deallocate.
 989  */
 990 int ib_dealloc_pd(struct ib_pd *pd);
 991
 992 /**
 993  * ib_create_ah - Creates an address handle for the given address vector.
 994  * @pd: The protection domain associated with the address handle.
 995  * @ah_attr: The attributes of the address vector.
 996  *
 997  * The address handle is used to reference a local or global destination
 998  * in all UD QP post sends.
 999  */
1000 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1001
1002 /**
1003  * ib_create_ah_from_wc - Creates an address handle associated with the
1004  *   sender of the specified work completion.
1005  * @pd: The protection domain associated with the address handle.
1006  * @wc: Work completion information associated with a received message.
1007  * @grh: References the received global route header.  This parameter is
1008  *   ignored unless the work completion indicates that the GRH is valid.
1009  * @port_num: The outbound port number to associate with the address.
1010  *
1011  * The address handle is used to reference a local or global destination
1012  * in all UD QP post sends.
1013  */
1014 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1015                                    struct ib_grh *grh, u8 port_num);
1016
1017 /**
1018  * ib_modify_ah - Modifies the address vector associated with an address
1019  *   handle.
1020  * @ah: The address handle to modify.
1021  * @ah_attr: The new address vector attributes to associate with the
1022  *   address handle.
1023  */
1024 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1025
1026 /**
1027  * ib_query_ah - Queries the address vector associated with an address
1028  *   handle.
1029  * @ah: The address handle to query.
1030  * @ah_attr: The address vector attributes associated with the address
1031  *   handle.
1032  */
1033 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1034
1035 /**
1036  * ib_destroy_ah - Destroys an address handle.
1037  * @ah: The address handle to destroy.
1038  */
1039 int ib_destroy_ah(struct ib_ah *ah);
1040
1041 /**
1042  * ib_create_qp - Creates a QP associated with the specified protection
1043  *   domain.
1044  * @pd: The protection domain associated with the QP.
1045  * @qp_init_attr: A list of initial attributes required to create the QP.
1046  */
1047 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1048                            struct ib_qp_init_attr *qp_init_attr);
1049
1050 /**
1051  * ib_modify_qp - Modifies the attributes for the specified QP and then
1052  *   transitions the QP to the given state.
1053  * @qp: The QP to modify.
1054  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1055  *   the current values of selected QP attributes are returned.
1056  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1057  *   are being modified.
1058  */
1059 int ib_modify_qp(struct ib_qp *qp,
1060                  struct ib_qp_attr *qp_attr,
1061                  int qp_attr_mask);
1062
1063 /**
1064  * ib_query_qp - Returns the attribute list and current values for the
1065  *   specified QP.
1066  * @qp: The QP to query.
1067  * @qp_attr: The attributes of the specified QP.
1068  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1069  * @qp_init_attr: Additional attributes of the selected QP.
1070  *
1071  * The qp_attr_mask may be used to limit the query to gathering only the
1072  * selected attributes.
1073  */
1074 int ib_query_qp(struct ib_qp *qp,
1075                 struct ib_qp_attr *qp_attr,
1076                 int qp_attr_mask,
1077                 struct ib_qp_init_attr *qp_init_attr);
1078
1079 /**
1080  * ib_destroy_qp - Destroys the specified QP.
1081  * @qp: The QP to destroy.
1082  */
1083 int ib_destroy_qp(struct ib_qp *qp);
1084
1085 /**
1086  * ib_post_send - Posts a list of work requests to the send queue of
1087  *   the specified QP.
1088  * @qp: The QP to post the work request on.
1089  * @send_wr: A list of work requests to post on the send queue.
1090  * @bad_send_wr: On an immediate failure, this parameter will reference
1091  *   the work request that failed to be posted on the QP.
1092  */
1093 static inline int ib_post_send(struct ib_qp *qp,
1094                                struct ib_send_wr *send_wr,
1095                                struct ib_send_wr **bad_send_wr)
1096 {
1097         return qp->device->post_send(qp, send_wr, bad_send_wr);
1098 }
1099
1100 /**
1101  * ib_post_recv - Posts a list of work requests to the receive queue of
1102  *   the specified QP.
1103  * @qp: The QP to post the work request on.
1104  * @recv_wr: A list of work requests to post on the receive queue.
1105  * @bad_recv_wr: On an immediate failure, this parameter will reference
1106  *   the work request that failed to be posted on the QP.
1107  */
1108 static inline int ib_post_recv(struct ib_qp *qp,
1109                                struct ib_recv_wr *recv_wr,
1110                                struct ib_recv_wr **bad_recv_wr)
1111 {
1112         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1113 }
1114
1115 /**
1116  * ib_create_cq - Creates a CQ on the specified device.
1117  * @device: The device on which to create the CQ.
1118  * @comp_handler: A user-specified callback that is invoked when a
1119  *   completion event occurs on the CQ.
1120  * @event_handler: A user-specified callback that is invoked when an
1121  *   asynchronous event not associated with a completion occurs on the CQ.
1122  * @cq_context: Context associated with the CQ returned to the user via
1123  *   the associated completion and event handlers.
1124  * @cqe: The minimum size of the CQ.
1125  *
1126  * Users can examine the cq structure to determine the actual CQ size.
1127  */
1128 struct ib_cq *ib_create_cq(struct ib_device *device,
1129                            ib_comp_handler comp_handler,
1130                            void (*event_handler)(struct ib_event *, void *),
1131                            void *cq_context, int cqe);
1132
1133 /**
1134  * ib_resize_cq - Modifies the capacity of the CQ.
1135  * @cq: The CQ to resize.
1136  * @cqe: The minimum size of the CQ.
1137  *
1138  * Users can examine the cq structure to determine the actual CQ size.
1139  */
1140 int ib_resize_cq(struct ib_cq *cq, int cqe);
1141
1142 /**
1143  * ib_destroy_cq - Destroys the specified CQ.
1144  * @cq: The CQ to destroy.
1145  */
1146 int ib_destroy_cq(struct ib_cq *cq);
1147
1148 /**
1149  * ib_poll_cq - poll a CQ for completion(s)
1150  * @cq:the CQ being polled
1151  * @num_entries:maximum number of completions to return
1152  * @wc:array of at least @num_entries &struct ib_wc where completions
1153  *   will be returned
1154  *
1155  * Poll a CQ for (possibly multiple) completions.  If the return value
1156  * is < 0, an error occurred.  If the return value is >= 0, it is the
1157  * number of completions returned.  If the return value is
1158  * non-negative and < num_entries, then the CQ was emptied.
1159  */
1160 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1161                              struct ib_wc *wc)
1162 {
1163         return cq->device->poll_cq(cq, num_entries, wc);
1164 }
1165
1166 /**
1167  * ib_peek_cq - Returns the number of unreaped completions currently
1168  *   on the specified CQ.
1169  * @cq: The CQ to peek.
1170  * @wc_cnt: A minimum number of unreaped completions to check for.
1171  *
1172  * If the number of unreaped completions is greater than or equal to wc_cnt,
1173  * this function returns wc_cnt, otherwise, it returns the actual number of
1174  * unreaped completions.
1175  */
1176 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1177
1178 /**
1179  * ib_req_notify_cq - Request completion notification on a CQ.
1180  * @cq: The CQ to generate an event for.
1181  * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
1182  *   occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
1183  *   notification will occur on the next completion.
1184  */
1185 static inline int ib_req_notify_cq(struct ib_cq *cq,
1186                                    enum ib_cq_notify cq_notify)
1187 {
1188         return cq->device->req_notify_cq(cq, cq_notify);
1189 }
1190
1191 /**
1192  * ib_req_ncomp_notif - Request completion notification when there are
1193  *   at least the specified number of unreaped completions on the CQ.
1194  * @cq: The CQ to generate an event for.
1195  * @wc_cnt: The number of unreaped completions that should be on the
1196  *   CQ before an event is generated.
1197  */
1198 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1199 {
1200         return cq->device->req_ncomp_notif ?
1201                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1202                 -ENOSYS;
1203 }
1204
1205 /**
1206  * ib_get_dma_mr - Returns a memory region for system memory that is
1207  *   usable for DMA.
1208  * @pd: The protection domain associated with the memory region.
1209  * @mr_access_flags: Specifies the memory access rights.
1210  */
1211 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1212
1213 /**
1214  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1215  *   by an HCA.
1216  * @pd: The protection domain associated assigned to the registered region.
1217  * @phys_buf_array: Specifies a list of physical buffers to use in the
1218  *   memory region.
1219  * @num_phys_buf: Specifies the size of the phys_buf_array.
1220  * @mr_access_flags: Specifies the memory access rights.
1221  * @iova_start: The offset of the region's starting I/O virtual address.
1222  */
1223 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1224                              struct ib_phys_buf *phys_buf_array,
1225                              int num_phys_buf,
1226                              int mr_access_flags,
1227                              u64 *iova_start);
1228
1229 /**
1230  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1231  *   Conceptually, this call performs the functions deregister memory region
1232  *   followed by register physical memory region.  Where possible,
1233  *   resources are reused instead of deallocated and reallocated.
1234  * @mr: The memory region to modify.
1235  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1236  *   properties of the memory region are being modified.
1237  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1238  *   the new protection domain to associated with the memory region,
1239  *   otherwise, this parameter is ignored.
1240  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1241  *   field specifies a list of physical buffers to use in the new
1242  *   translation, otherwise, this parameter is ignored.
1243  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1244  *   field specifies the size of the phys_buf_array, otherwise, this
1245  *   parameter is ignored.
1246  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1247  *   field specifies the new memory access rights, otherwise, this
1248  *   parameter is ignored.
1249  * @iova_start: The offset of the region's starting I/O virtual address.
1250  */
1251 int ib_rereg_phys_mr(struct ib_mr *mr,
1252                      int mr_rereg_mask,
1253                      struct ib_pd *pd,
1254                      struct ib_phys_buf *phys_buf_array,
1255                      int num_phys_buf,
1256                      int mr_access_flags,
1257                      u64 *iova_start);
1258
1259 /**
1260  * ib_query_mr - Retrieves information about a specific memory region.
1261  * @mr: The memory region to retrieve information about.
1262  * @mr_attr: The attributes of the specified memory region.
1263  */
1264 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1265
1266 /**
1267  * ib_dereg_mr - Deregisters a memory region and removes it from the
1268  *   HCA translation table.
1269  * @mr: The memory region to deregister.
1270  */
1271 int ib_dereg_mr(struct ib_mr *mr);
1272
1273 /**
1274  * ib_alloc_mw - Allocates a memory window.
1275  * @pd: The protection domain associated with the memory window.
1276  */
1277 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1278
1279 /**
1280  * ib_bind_mw - Posts a work request to the send queue of the specified
1281  *   QP, which binds the memory window to the given address range and
1282  *   remote access attributes.
1283  * @qp: QP to post the bind work request on.
1284  * @mw: The memory window to bind.
1285  * @mw_bind: Specifies information about the memory window, including
1286  *   its address range, remote access rights, and associated memory region.
1287  */
1288 static inline int ib_bind_mw(struct ib_qp *qp,
1289                              struct ib_mw *mw,
1290                              struct ib_mw_bind *mw_bind)
1291 {
1292         /* XXX reference counting in corresponding MR? */
1293         return mw->device->bind_mw ?
1294                 mw->device->bind_mw(qp, mw, mw_bind) :
1295                 -ENOSYS;
1296 }
1297
1298 /**
1299  * ib_dealloc_mw - Deallocates a memory window.
1300  * @mw: The memory window to deallocate.
1301  */
1302 int ib_dealloc_mw(struct ib_mw *mw);
1303
1304 /**
1305  * ib_alloc_fmr - Allocates a unmapped fast memory region.
1306  * @pd: The protection domain associated with the unmapped region.
1307  * @mr_access_flags: Specifies the memory access rights.
1308  * @fmr_attr: Attributes of the unmapped region.
1309  *
1310  * A fast memory region must be mapped before it can be used as part of
1311  * a work request.
1312  */
1313 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1314                             int mr_access_flags,
1315                             struct ib_fmr_attr *fmr_attr);
1316
1317 /**
1318  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1319  * @fmr: The fast memory region to associate with the pages.
1320  * @page_list: An array of physical pages to map to the fast memory region.
1321  * @list_len: The number of pages in page_list.
1322  * @iova: The I/O virtual address to use with the mapped region.
1323  */
1324 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1325                                   u64 *page_list, int list_len,
1326                                   u64 iova)
1327 {
1328         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1329 }
1330
1331 /**
1332  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1333  * @fmr_list: A linked list of fast memory regions to unmap.
1334  */
1335 int ib_unmap_fmr(struct list_head *fmr_list);
1336
1337 /**
1338  * ib_dealloc_fmr - Deallocates a fast memory region.
1339  * @fmr: The fast memory region to deallocate.
1340  */
1341 int ib_dealloc_fmr(struct ib_fmr *fmr);
1342
1343 /**
1344  * ib_attach_mcast - Attaches the specified QP to a multicast group.
1345  * @qp: QP to attach to the multicast group.  The QP must be type
1346  *   IB_QPT_UD.
1347  * @gid: Multicast group GID.
1348  * @lid: Multicast group LID in host byte order.
1349  *
1350  * In order to send and receive multicast packets, subnet
1351  * administration must have created the multicast group and configured
1352  * the fabric appropriately.  The port associated with the specified
1353  * QP must also be a member of the multicast group.
1354  */
1355 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1356
1357 /**
1358  * ib_detach_mcast - Detaches the specified QP from a multicast group.
1359  * @qp: QP to detach from the multicast group.
1360  * @gid: Multicast group GID.
1361  * @lid: Multicast group LID in host byte order.
1362  */
1363 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1364
1365 #endif /* IB_VERBS_H */