blob: dfd9b87b7ffd0eb05fe74edd9fa39160e21e1d71 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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.
Roland Dreier2a1d9b72005-08-10 23:03:10 -07007 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
Roland Dreierf7c6a7b2007-03-04 16:15:11 -08008 * Copyright (c) 2005, 2006, 2007 Cisco Systems. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 */
38
39#if !defined(IB_VERBS_H)
40#define IB_VERBS_H
41
42#include <linux/types.h>
43#include <linux/device.h>
Ralph Campbell9b513092006-12-12 14:27:41 -080044#include <linux/mm.h>
45#include <linux/dma-mapping.h>
Michael S. Tsirkin459d6e22007-02-04 14:11:55 -080046#include <linux/kref.h>
Dotan Barakbfb3ea12007-07-31 16:49:15 +030047#include <linux/list.h>
48#include <linux/rwsem.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010049#include <linux/scatterlist.h>
Tejun Heof0626712010-10-19 15:24:36 +000050#include <linux/workqueue.h>
Roland Dreiere2773c02005-07-07 17:57:10 -070051
Arun Sharma600634972011-07-26 16:09:06 -070052#include <linux/atomic.h>
Roland Dreiere2773c02005-07-07 17:57:10 -070053#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heof0626712010-10-19 15:24:36 +000055extern struct workqueue_struct *ib_wq;
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057union ib_gid {
58 u8 raw[16];
59 struct {
Sean Hefty97f52eb2005-08-13 21:05:57 -070060 __be64 subnet_prefix;
61 __be64 interface_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 } global;
63};
64
Tom Tucker07ebafb2006-08-03 16:02:42 -050065enum rdma_node_type {
66 /* IB values map to NodeInfo:NodeType. */
67 RDMA_NODE_IB_CA = 1,
68 RDMA_NODE_IB_SWITCH,
69 RDMA_NODE_IB_ROUTER,
70 RDMA_NODE_RNIC
Linus Torvalds1da177e2005-04-16 15:20:36 -070071};
72
Tom Tucker07ebafb2006-08-03 16:02:42 -050073enum rdma_transport_type {
74 RDMA_TRANSPORT_IB,
75 RDMA_TRANSPORT_IWARP
76};
77
78enum rdma_transport_type
79rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
80
Eli Cohena3f5ada2010-09-27 17:51:10 -070081enum rdma_link_layer {
82 IB_LINK_LAYER_UNSPECIFIED,
83 IB_LINK_LAYER_INFINIBAND,
84 IB_LINK_LAYER_ETHERNET,
85};
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087enum ib_device_cap_flags {
88 IB_DEVICE_RESIZE_MAX_WR = 1,
89 IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
90 IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
91 IB_DEVICE_RAW_MULTI = (1<<3),
92 IB_DEVICE_AUTO_PATH_MIG = (1<<4),
93 IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
94 IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
95 IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
96 IB_DEVICE_SHUTDOWN_PORT = (1<<8),
97 IB_DEVICE_INIT_TYPE = (1<<9),
98 IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
99 IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
100 IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
101 IB_DEVICE_SRQ_RESIZE = (1<<13),
102 IB_DEVICE_N_NOTIFY_CQ = (1<<14),
Steve Wise96f15c02008-07-14 23:48:53 -0700103 IB_DEVICE_LOCAL_DMA_LKEY = (1<<15),
Roland Dreier0f39cf32008-04-16 21:09:32 -0700104 IB_DEVICE_RESERVED = (1<<16), /* old SEND_W_INV */
Eli Cohene0605d92008-01-30 18:30:57 +0200105 IB_DEVICE_MEM_WINDOW = (1<<17),
106 /*
107 * Devices should set IB_DEVICE_UD_IP_SUM if they support
108 * insertion of UDP and TCP checksum on outgoing UD IPoIB
109 * messages and can verify the validity of checksum for
110 * incoming messages. Setting this flag implies that the
111 * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
112 */
113 IB_DEVICE_UD_IP_CSUM = (1<<18),
Eli Cohenc93570f2008-04-16 21:09:27 -0700114 IB_DEVICE_UD_TSO = (1<<19),
Sean Hefty59991f92011-05-23 17:52:46 -0700115 IB_DEVICE_XRC = (1<<20),
Steve Wise00f7ec32008-07-14 23:48:45 -0700116 IB_DEVICE_MEM_MGT_EXTENSIONS = (1<<21),
Ron Livne47ee1b92008-07-14 23:48:48 -0700117 IB_DEVICE_BLOCK_MULTICAST_LOOPBACK = (1<<22),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118};
119
120enum ib_atomic_cap {
121 IB_ATOMIC_NONE,
122 IB_ATOMIC_HCA,
123 IB_ATOMIC_GLOB
124};
125
126struct ib_device_attr {
127 u64 fw_ver;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700128 __be64 sys_image_guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 u64 max_mr_size;
130 u64 page_size_cap;
131 u32 vendor_id;
132 u32 vendor_part_id;
133 u32 hw_ver;
134 int max_qp;
135 int max_qp_wr;
136 int device_cap_flags;
137 int max_sge;
138 int max_sge_rd;
139 int max_cq;
140 int max_cqe;
141 int max_mr;
142 int max_pd;
143 int max_qp_rd_atom;
144 int max_ee_rd_atom;
145 int max_res_rd_atom;
146 int max_qp_init_rd_atom;
147 int max_ee_init_rd_atom;
148 enum ib_atomic_cap atomic_cap;
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300149 enum ib_atomic_cap masked_atomic_cap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 int max_ee;
151 int max_rdd;
152 int max_mw;
153 int max_raw_ipv6_qp;
154 int max_raw_ethy_qp;
155 int max_mcast_grp;
156 int max_mcast_qp_attach;
157 int max_total_mcast_qp_attach;
158 int max_ah;
159 int max_fmr;
160 int max_map_per_fmr;
161 int max_srq;
162 int max_srq_wr;
163 int max_srq_sge;
Steve Wise00f7ec32008-07-14 23:48:45 -0700164 unsigned int max_fast_reg_page_list_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 u16 max_pkeys;
166 u8 local_ca_ack_delay;
167};
168
169enum ib_mtu {
170 IB_MTU_256 = 1,
171 IB_MTU_512 = 2,
172 IB_MTU_1024 = 3,
173 IB_MTU_2048 = 4,
174 IB_MTU_4096 = 5
175};
176
177static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
178{
179 switch (mtu) {
180 case IB_MTU_256: return 256;
181 case IB_MTU_512: return 512;
182 case IB_MTU_1024: return 1024;
183 case IB_MTU_2048: return 2048;
184 case IB_MTU_4096: return 4096;
185 default: return -1;
186 }
187}
188
189enum ib_port_state {
190 IB_PORT_NOP = 0,
191 IB_PORT_DOWN = 1,
192 IB_PORT_INIT = 2,
193 IB_PORT_ARMED = 3,
194 IB_PORT_ACTIVE = 4,
195 IB_PORT_ACTIVE_DEFER = 5
196};
197
198enum ib_port_cap_flags {
199 IB_PORT_SM = 1 << 1,
200 IB_PORT_NOTICE_SUP = 1 << 2,
201 IB_PORT_TRAP_SUP = 1 << 3,
202 IB_PORT_OPT_IPD_SUP = 1 << 4,
203 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
204 IB_PORT_SL_MAP_SUP = 1 << 6,
205 IB_PORT_MKEY_NVRAM = 1 << 7,
206 IB_PORT_PKEY_NVRAM = 1 << 8,
207 IB_PORT_LED_INFO_SUP = 1 << 9,
208 IB_PORT_SM_DISABLED = 1 << 10,
209 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
210 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
211 IB_PORT_CM_SUP = 1 << 16,
212 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
213 IB_PORT_REINIT_SUP = 1 << 18,
214 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
215 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
216 IB_PORT_DR_NOTICE_SUP = 1 << 21,
217 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
218 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
219 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
220 IB_PORT_CLIENT_REG_SUP = 1 << 25
221};
222
223enum ib_port_width {
224 IB_WIDTH_1X = 1,
225 IB_WIDTH_4X = 2,
226 IB_WIDTH_8X = 4,
227 IB_WIDTH_12X = 8
228};
229
230static inline int ib_width_enum_to_int(enum ib_port_width width)
231{
232 switch (width) {
233 case IB_WIDTH_1X: return 1;
234 case IB_WIDTH_4X: return 4;
235 case IB_WIDTH_8X: return 8;
236 case IB_WIDTH_12X: return 12;
237 default: return -1;
238 }
239}
240
Steve Wise7f624d02008-07-14 23:48:48 -0700241struct ib_protocol_stats {
242 /* TBD... */
243};
244
245struct iw_protocol_stats {
246 u64 ipInReceives;
247 u64 ipInHdrErrors;
248 u64 ipInTooBigErrors;
249 u64 ipInNoRoutes;
250 u64 ipInAddrErrors;
251 u64 ipInUnknownProtos;
252 u64 ipInTruncatedPkts;
253 u64 ipInDiscards;
254 u64 ipInDelivers;
255 u64 ipOutForwDatagrams;
256 u64 ipOutRequests;
257 u64 ipOutDiscards;
258 u64 ipOutNoRoutes;
259 u64 ipReasmTimeout;
260 u64 ipReasmReqds;
261 u64 ipReasmOKs;
262 u64 ipReasmFails;
263 u64 ipFragOKs;
264 u64 ipFragFails;
265 u64 ipFragCreates;
266 u64 ipInMcastPkts;
267 u64 ipOutMcastPkts;
268 u64 ipInBcastPkts;
269 u64 ipOutBcastPkts;
270
271 u64 tcpRtoAlgorithm;
272 u64 tcpRtoMin;
273 u64 tcpRtoMax;
274 u64 tcpMaxConn;
275 u64 tcpActiveOpens;
276 u64 tcpPassiveOpens;
277 u64 tcpAttemptFails;
278 u64 tcpEstabResets;
279 u64 tcpCurrEstab;
280 u64 tcpInSegs;
281 u64 tcpOutSegs;
282 u64 tcpRetransSegs;
283 u64 tcpInErrs;
284 u64 tcpOutRsts;
285};
286
287union rdma_protocol_stats {
288 struct ib_protocol_stats ib;
289 struct iw_protocol_stats iw;
290};
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292struct ib_port_attr {
293 enum ib_port_state state;
294 enum ib_mtu max_mtu;
295 enum ib_mtu active_mtu;
296 int gid_tbl_len;
297 u32 port_cap_flags;
298 u32 max_msg_sz;
299 u32 bad_pkey_cntr;
300 u32 qkey_viol_cntr;
301 u16 pkey_tbl_len;
302 u16 lid;
303 u16 sm_lid;
304 u8 lmc;
305 u8 max_vl_num;
306 u8 sm_sl;
307 u8 subnet_timeout;
308 u8 init_type_reply;
309 u8 active_width;
310 u8 active_speed;
311 u8 phys_state;
312};
313
314enum ib_device_modify_flags {
Roland Dreierc5bcbbb2006-02-02 09:47:14 -0800315 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
316 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317};
318
319struct ib_device_modify {
320 u64 sys_image_guid;
Roland Dreierc5bcbbb2006-02-02 09:47:14 -0800321 char node_desc[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322};
323
324enum ib_port_modify_flags {
325 IB_PORT_SHUTDOWN = 1,
326 IB_PORT_INIT_TYPE = (1<<2),
327 IB_PORT_RESET_QKEY_CNTR = (1<<3)
328};
329
330struct ib_port_modify {
331 u32 set_port_cap_mask;
332 u32 clr_port_cap_mask;
333 u8 init_type;
334};
335
336enum ib_event_type {
337 IB_EVENT_CQ_ERR,
338 IB_EVENT_QP_FATAL,
339 IB_EVENT_QP_REQ_ERR,
340 IB_EVENT_QP_ACCESS_ERR,
341 IB_EVENT_COMM_EST,
342 IB_EVENT_SQ_DRAINED,
343 IB_EVENT_PATH_MIG,
344 IB_EVENT_PATH_MIG_ERR,
345 IB_EVENT_DEVICE_FATAL,
346 IB_EVENT_PORT_ACTIVE,
347 IB_EVENT_PORT_ERR,
348 IB_EVENT_LID_CHANGE,
349 IB_EVENT_PKEY_CHANGE,
Roland Dreierd41fcc62005-08-18 12:23:08 -0700350 IB_EVENT_SM_CHANGE,
351 IB_EVENT_SRQ_ERR,
352 IB_EVENT_SRQ_LIMIT_REACHED,
Leonid Arsh63942c92006-06-17 20:37:35 -0700353 IB_EVENT_QP_LAST_WQE_REACHED,
Or Gerlitz761d90e2011-06-15 14:39:29 +0000354 IB_EVENT_CLIENT_REREGISTER,
355 IB_EVENT_GID_CHANGE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356};
357
358struct ib_event {
359 struct ib_device *device;
360 union {
361 struct ib_cq *cq;
362 struct ib_qp *qp;
Roland Dreierd41fcc62005-08-18 12:23:08 -0700363 struct ib_srq *srq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 u8 port_num;
365 } element;
366 enum ib_event_type event;
367};
368
369struct ib_event_handler {
370 struct ib_device *device;
371 void (*handler)(struct ib_event_handler *, struct ib_event *);
372 struct list_head list;
373};
374
375#define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
376 do { \
377 (_ptr)->device = _device; \
378 (_ptr)->handler = _handler; \
379 INIT_LIST_HEAD(&(_ptr)->list); \
380 } while (0)
381
382struct ib_global_route {
383 union ib_gid dgid;
384 u32 flow_label;
385 u8 sgid_index;
386 u8 hop_limit;
387 u8 traffic_class;
388};
389
Hal Rosenstock513789e2005-07-27 11:45:34 -0700390struct ib_grh {
Sean Hefty97f52eb2005-08-13 21:05:57 -0700391 __be32 version_tclass_flow;
392 __be16 paylen;
Hal Rosenstock513789e2005-07-27 11:45:34 -0700393 u8 next_hdr;
394 u8 hop_limit;
395 union ib_gid sgid;
396 union ib_gid dgid;
397};
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399enum {
400 IB_MULTICAST_QPN = 0xffffff
401};
402
Harvey Harrisonf3a7c662009-02-14 22:58:35 -0800403#define IB_LID_PERMISSIVE cpu_to_be16(0xFFFF)
Sean Hefty97f52eb2005-08-13 21:05:57 -0700404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405enum ib_ah_flags {
406 IB_AH_GRH = 1
407};
408
Jack Morgensteinbf6a9e32006-04-10 09:43:47 -0700409enum ib_rate {
410 IB_RATE_PORT_CURRENT = 0,
411 IB_RATE_2_5_GBPS = 2,
412 IB_RATE_5_GBPS = 5,
413 IB_RATE_10_GBPS = 3,
414 IB_RATE_20_GBPS = 6,
415 IB_RATE_30_GBPS = 4,
416 IB_RATE_40_GBPS = 7,
417 IB_RATE_60_GBPS = 8,
418 IB_RATE_80_GBPS = 9,
419 IB_RATE_120_GBPS = 10
420};
421
422/**
423 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
424 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
425 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
426 * @rate: rate to convert.
427 */
428int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
429
430/**
431 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
432 * enum.
433 * @mult: multiple to convert.
434 */
435enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437struct ib_ah_attr {
438 struct ib_global_route grh;
439 u16 dlid;
440 u8 sl;
441 u8 src_path_bits;
442 u8 static_rate;
443 u8 ah_flags;
444 u8 port_num;
445};
446
447enum ib_wc_status {
448 IB_WC_SUCCESS,
449 IB_WC_LOC_LEN_ERR,
450 IB_WC_LOC_QP_OP_ERR,
451 IB_WC_LOC_EEC_OP_ERR,
452 IB_WC_LOC_PROT_ERR,
453 IB_WC_WR_FLUSH_ERR,
454 IB_WC_MW_BIND_ERR,
455 IB_WC_BAD_RESP_ERR,
456 IB_WC_LOC_ACCESS_ERR,
457 IB_WC_REM_INV_REQ_ERR,
458 IB_WC_REM_ACCESS_ERR,
459 IB_WC_REM_OP_ERR,
460 IB_WC_RETRY_EXC_ERR,
461 IB_WC_RNR_RETRY_EXC_ERR,
462 IB_WC_LOC_RDD_VIOL_ERR,
463 IB_WC_REM_INV_RD_REQ_ERR,
464 IB_WC_REM_ABORT_ERR,
465 IB_WC_INV_EECN_ERR,
466 IB_WC_INV_EEC_STATE_ERR,
467 IB_WC_FATAL_ERR,
468 IB_WC_RESP_TIMEOUT_ERR,
469 IB_WC_GENERAL_ERR
470};
471
472enum ib_wc_opcode {
473 IB_WC_SEND,
474 IB_WC_RDMA_WRITE,
475 IB_WC_RDMA_READ,
476 IB_WC_COMP_SWAP,
477 IB_WC_FETCH_ADD,
478 IB_WC_BIND_MW,
Eli Cohenc93570f2008-04-16 21:09:27 -0700479 IB_WC_LSO,
Steve Wise00f7ec32008-07-14 23:48:45 -0700480 IB_WC_LOCAL_INV,
481 IB_WC_FAST_REG_MR,
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300482 IB_WC_MASKED_COMP_SWAP,
483 IB_WC_MASKED_FETCH_ADD,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484/*
485 * Set value of IB_WC_RECV so consumers can test if a completion is a
486 * receive by testing (opcode & IB_WC_RECV).
487 */
488 IB_WC_RECV = 1 << 7,
489 IB_WC_RECV_RDMA_WITH_IMM
490};
491
492enum ib_wc_flags {
493 IB_WC_GRH = 1,
Steve Wise00f7ec32008-07-14 23:48:45 -0700494 IB_WC_WITH_IMM = (1<<1),
495 IB_WC_WITH_INVALIDATE = (1<<2),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496};
497
498struct ib_wc {
499 u64 wr_id;
500 enum ib_wc_status status;
501 enum ib_wc_opcode opcode;
502 u32 vendor_err;
503 u32 byte_len;
Michael S. Tsirkin062dbb62006-12-31 21:09:42 +0200504 struct ib_qp *qp;
Steve Wise00f7ec32008-07-14 23:48:45 -0700505 union {
506 __be32 imm_data;
507 u32 invalidate_rkey;
508 } ex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 u32 src_qp;
510 int wc_flags;
511 u16 pkey_index;
512 u16 slid;
513 u8 sl;
514 u8 dlid_path_bits;
515 u8 port_num; /* valid only for DR SMPs on switches */
Eli Cohene0605d92008-01-30 18:30:57 +0200516 int csum_ok;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517};
518
Roland Dreiered23a722007-05-06 21:02:48 -0700519enum ib_cq_notify_flags {
520 IB_CQ_SOLICITED = 1 << 0,
521 IB_CQ_NEXT_COMP = 1 << 1,
522 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
523 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524};
525
Sean Hefty96104ed2011-05-23 16:31:36 -0700526enum ib_srq_type {
Sean Hefty418d5132011-05-23 19:42:29 -0700527 IB_SRQT_BASIC,
528 IB_SRQT_XRC
Sean Hefty96104ed2011-05-23 16:31:36 -0700529};
530
Roland Dreierd41fcc62005-08-18 12:23:08 -0700531enum ib_srq_attr_mask {
532 IB_SRQ_MAX_WR = 1 << 0,
533 IB_SRQ_LIMIT = 1 << 1,
534};
535
536struct ib_srq_attr {
537 u32 max_wr;
538 u32 max_sge;
539 u32 srq_limit;
540};
541
542struct ib_srq_init_attr {
543 void (*event_handler)(struct ib_event *, void *);
544 void *srq_context;
545 struct ib_srq_attr attr;
Sean Hefty96104ed2011-05-23 16:31:36 -0700546 enum ib_srq_type srq_type;
Sean Hefty418d5132011-05-23 19:42:29 -0700547
548 union {
549 struct {
550 struct ib_xrcd *xrcd;
551 struct ib_cq *cq;
552 } xrc;
553 } ext;
Roland Dreierd41fcc62005-08-18 12:23:08 -0700554};
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556struct ib_qp_cap {
557 u32 max_send_wr;
558 u32 max_recv_wr;
559 u32 max_send_sge;
560 u32 max_recv_sge;
561 u32 max_inline_data;
562};
563
564enum ib_sig_type {
565 IB_SIGNAL_ALL_WR,
566 IB_SIGNAL_REQ_WR
567};
568
569enum ib_qp_type {
570 /*
571 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
572 * here (and in that order) since the MAD layer uses them as
573 * indices into a 2-entry table.
574 */
575 IB_QPT_SMI,
576 IB_QPT_GSI,
577
578 IB_QPT_RC,
579 IB_QPT_UC,
580 IB_QPT_UD,
581 IB_QPT_RAW_IPV6,
Sean Heftyb42b63c2011-05-23 19:59:25 -0700582 IB_QPT_RAW_ETHERTYPE,
583 /* Save 8 for RAW_PACKET */
584 IB_QPT_XRC_INI = 9,
585 IB_QPT_XRC_TGT,
586 IB_QPT_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587};
588
Eli Cohenb846f252008-04-16 21:09:27 -0700589enum ib_qp_create_flags {
Ron Livne47ee1b92008-07-14 23:48:48 -0700590 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
591 IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK = 1 << 1,
Eli Cohenb846f252008-04-16 21:09:27 -0700592};
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594struct ib_qp_init_attr {
595 void (*event_handler)(struct ib_event *, void *);
596 void *qp_context;
597 struct ib_cq *send_cq;
598 struct ib_cq *recv_cq;
599 struct ib_srq *srq;
Sean Heftyb42b63c2011-05-23 19:59:25 -0700600 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 struct ib_qp_cap cap;
602 enum ib_sig_type sq_sig_type;
603 enum ib_qp_type qp_type;
Eli Cohenb846f252008-04-16 21:09:27 -0700604 enum ib_qp_create_flags create_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 u8 port_num; /* special QP types only */
606};
607
608enum ib_rnr_timeout {
609 IB_RNR_TIMER_655_36 = 0,
610 IB_RNR_TIMER_000_01 = 1,
611 IB_RNR_TIMER_000_02 = 2,
612 IB_RNR_TIMER_000_03 = 3,
613 IB_RNR_TIMER_000_04 = 4,
614 IB_RNR_TIMER_000_06 = 5,
615 IB_RNR_TIMER_000_08 = 6,
616 IB_RNR_TIMER_000_12 = 7,
617 IB_RNR_TIMER_000_16 = 8,
618 IB_RNR_TIMER_000_24 = 9,
619 IB_RNR_TIMER_000_32 = 10,
620 IB_RNR_TIMER_000_48 = 11,
621 IB_RNR_TIMER_000_64 = 12,
622 IB_RNR_TIMER_000_96 = 13,
623 IB_RNR_TIMER_001_28 = 14,
624 IB_RNR_TIMER_001_92 = 15,
625 IB_RNR_TIMER_002_56 = 16,
626 IB_RNR_TIMER_003_84 = 17,
627 IB_RNR_TIMER_005_12 = 18,
628 IB_RNR_TIMER_007_68 = 19,
629 IB_RNR_TIMER_010_24 = 20,
630 IB_RNR_TIMER_015_36 = 21,
631 IB_RNR_TIMER_020_48 = 22,
632 IB_RNR_TIMER_030_72 = 23,
633 IB_RNR_TIMER_040_96 = 24,
634 IB_RNR_TIMER_061_44 = 25,
635 IB_RNR_TIMER_081_92 = 26,
636 IB_RNR_TIMER_122_88 = 27,
637 IB_RNR_TIMER_163_84 = 28,
638 IB_RNR_TIMER_245_76 = 29,
639 IB_RNR_TIMER_327_68 = 30,
640 IB_RNR_TIMER_491_52 = 31
641};
642
643enum ib_qp_attr_mask {
644 IB_QP_STATE = 1,
645 IB_QP_CUR_STATE = (1<<1),
646 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
647 IB_QP_ACCESS_FLAGS = (1<<3),
648 IB_QP_PKEY_INDEX = (1<<4),
649 IB_QP_PORT = (1<<5),
650 IB_QP_QKEY = (1<<6),
651 IB_QP_AV = (1<<7),
652 IB_QP_PATH_MTU = (1<<8),
653 IB_QP_TIMEOUT = (1<<9),
654 IB_QP_RETRY_CNT = (1<<10),
655 IB_QP_RNR_RETRY = (1<<11),
656 IB_QP_RQ_PSN = (1<<12),
657 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
658 IB_QP_ALT_PATH = (1<<14),
659 IB_QP_MIN_RNR_TIMER = (1<<15),
660 IB_QP_SQ_PSN = (1<<16),
661 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
662 IB_QP_PATH_MIG_STATE = (1<<18),
663 IB_QP_CAP = (1<<19),
664 IB_QP_DEST_QPN = (1<<20)
665};
666
667enum ib_qp_state {
668 IB_QPS_RESET,
669 IB_QPS_INIT,
670 IB_QPS_RTR,
671 IB_QPS_RTS,
672 IB_QPS_SQD,
673 IB_QPS_SQE,
674 IB_QPS_ERR
675};
676
677enum ib_mig_state {
678 IB_MIG_MIGRATED,
679 IB_MIG_REARM,
680 IB_MIG_ARMED
681};
682
683struct ib_qp_attr {
684 enum ib_qp_state qp_state;
685 enum ib_qp_state cur_qp_state;
686 enum ib_mtu path_mtu;
687 enum ib_mig_state path_mig_state;
688 u32 qkey;
689 u32 rq_psn;
690 u32 sq_psn;
691 u32 dest_qp_num;
692 int qp_access_flags;
693 struct ib_qp_cap cap;
694 struct ib_ah_attr ah_attr;
695 struct ib_ah_attr alt_ah_attr;
696 u16 pkey_index;
697 u16 alt_pkey_index;
698 u8 en_sqd_async_notify;
699 u8 sq_draining;
700 u8 max_rd_atomic;
701 u8 max_dest_rd_atomic;
702 u8 min_rnr_timer;
703 u8 port_num;
704 u8 timeout;
705 u8 retry_cnt;
706 u8 rnr_retry;
707 u8 alt_port_num;
708 u8 alt_timeout;
709};
710
711enum ib_wr_opcode {
712 IB_WR_RDMA_WRITE,
713 IB_WR_RDMA_WRITE_WITH_IMM,
714 IB_WR_SEND,
715 IB_WR_SEND_WITH_IMM,
716 IB_WR_RDMA_READ,
717 IB_WR_ATOMIC_CMP_AND_SWP,
Eli Cohenc93570f2008-04-16 21:09:27 -0700718 IB_WR_ATOMIC_FETCH_AND_ADD,
Roland Dreier0f39cf32008-04-16 21:09:32 -0700719 IB_WR_LSO,
720 IB_WR_SEND_WITH_INV,
Steve Wise00f7ec32008-07-14 23:48:45 -0700721 IB_WR_RDMA_READ_WITH_INV,
722 IB_WR_LOCAL_INV,
723 IB_WR_FAST_REG_MR,
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300724 IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
725 IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726};
727
728enum ib_send_flags {
729 IB_SEND_FENCE = 1,
730 IB_SEND_SIGNALED = (1<<1),
731 IB_SEND_SOLICITED = (1<<2),
Eli Cohene0605d92008-01-30 18:30:57 +0200732 IB_SEND_INLINE = (1<<3),
733 IB_SEND_IP_CSUM = (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734};
735
736struct ib_sge {
737 u64 addr;
738 u32 length;
739 u32 lkey;
740};
741
Steve Wise00f7ec32008-07-14 23:48:45 -0700742struct ib_fast_reg_page_list {
743 struct ib_device *device;
744 u64 *page_list;
745 unsigned int max_page_list_len;
746};
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748struct ib_send_wr {
749 struct ib_send_wr *next;
750 u64 wr_id;
751 struct ib_sge *sg_list;
752 int num_sge;
753 enum ib_wr_opcode opcode;
754 int send_flags;
Roland Dreier0f39cf32008-04-16 21:09:32 -0700755 union {
756 __be32 imm_data;
757 u32 invalidate_rkey;
758 } ex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 union {
760 struct {
761 u64 remote_addr;
762 u32 rkey;
763 } rdma;
764 struct {
765 u64 remote_addr;
766 u64 compare_add;
767 u64 swap;
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300768 u64 compare_add_mask;
769 u64 swap_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 u32 rkey;
771 } atomic;
772 struct {
773 struct ib_ah *ah;
Eli Cohenc93570f2008-04-16 21:09:27 -0700774 void *header;
775 int hlen;
776 int mss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 u32 remote_qpn;
778 u32 remote_qkey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 u16 pkey_index; /* valid for GSI only */
780 u8 port_num; /* valid for DR SMPs on switch only */
781 } ud;
Steve Wise00f7ec32008-07-14 23:48:45 -0700782 struct {
783 u64 iova_start;
784 struct ib_fast_reg_page_list *page_list;
785 unsigned int page_shift;
786 unsigned int page_list_len;
787 u32 length;
788 int access_flags;
789 u32 rkey;
790 } fast_reg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 } wr;
Sean Heftyb42b63c2011-05-23 19:59:25 -0700792 u32 xrc_remote_srq_num; /* XRC TGT QPs only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793};
794
795struct ib_recv_wr {
796 struct ib_recv_wr *next;
797 u64 wr_id;
798 struct ib_sge *sg_list;
799 int num_sge;
800};
801
802enum ib_access_flags {
803 IB_ACCESS_LOCAL_WRITE = 1,
804 IB_ACCESS_REMOTE_WRITE = (1<<1),
805 IB_ACCESS_REMOTE_READ = (1<<2),
806 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
807 IB_ACCESS_MW_BIND = (1<<4)
808};
809
810struct ib_phys_buf {
811 u64 addr;
812 u64 size;
813};
814
815struct ib_mr_attr {
816 struct ib_pd *pd;
817 u64 device_virt_addr;
818 u64 size;
819 int mr_access_flags;
820 u32 lkey;
821 u32 rkey;
822};
823
824enum ib_mr_rereg_flags {
825 IB_MR_REREG_TRANS = 1,
826 IB_MR_REREG_PD = (1<<1),
827 IB_MR_REREG_ACCESS = (1<<2)
828};
829
830struct ib_mw_bind {
831 struct ib_mr *mr;
832 u64 wr_id;
833 u64 addr;
834 u32 length;
835 int send_flags;
836 int mw_access_flags;
837};
838
839struct ib_fmr_attr {
840 int max_pages;
841 int max_maps;
Or Gerlitzd36f34a2006-02-02 10:43:45 -0800842 u8 page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843};
844
Roland Dreiere2773c02005-07-07 17:57:10 -0700845struct ib_ucontext {
846 struct ib_device *device;
847 struct list_head pd_list;
848 struct list_head mr_list;
849 struct list_head mw_list;
850 struct list_head cq_list;
851 struct list_head qp_list;
852 struct list_head srq_list;
853 struct list_head ah_list;
Sean Hefty53d0bd12011-05-24 08:33:46 -0700854 struct list_head xrcd_list;
Roland Dreierf7c6a7b2007-03-04 16:15:11 -0800855 int closing;
Roland Dreiere2773c02005-07-07 17:57:10 -0700856};
857
858struct ib_uobject {
859 u64 user_handle; /* handle given to us by userspace */
860 struct ib_ucontext *context; /* associated user context */
Roland Dreier9ead1902006-06-17 20:44:49 -0700861 void *object; /* containing object */
Roland Dreiere2773c02005-07-07 17:57:10 -0700862 struct list_head list; /* link to context's list */
Roland Dreierb3d636b2008-04-16 21:01:06 -0700863 int id; /* index into kernel idr */
Roland Dreier9ead1902006-06-17 20:44:49 -0700864 struct kref ref;
865 struct rw_semaphore mutex; /* protects .live */
866 int live;
Roland Dreiere2773c02005-07-07 17:57:10 -0700867};
868
Roland Dreiere2773c02005-07-07 17:57:10 -0700869struct ib_udata {
870 void __user *inbuf;
871 void __user *outbuf;
872 size_t inlen;
873 size_t outlen;
874};
875
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876struct ib_pd {
Roland Dreiere2773c02005-07-07 17:57:10 -0700877 struct ib_device *device;
878 struct ib_uobject *uobject;
879 atomic_t usecnt; /* count all resources */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880};
881
Sean Hefty59991f92011-05-23 17:52:46 -0700882struct ib_xrcd {
883 struct ib_device *device;
Sean Heftyd3d72d92011-05-26 23:06:44 -0700884 atomic_t usecnt; /* count all exposed resources */
Sean Hefty53d0bd12011-05-24 08:33:46 -0700885 struct inode *inode;
Sean Heftyd3d72d92011-05-26 23:06:44 -0700886
887 struct mutex tgt_qp_mutex;
888 struct list_head tgt_qp_list;
Sean Hefty59991f92011-05-23 17:52:46 -0700889};
890
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891struct ib_ah {
892 struct ib_device *device;
893 struct ib_pd *pd;
Roland Dreiere2773c02005-07-07 17:57:10 -0700894 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895};
896
897typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
898
899struct ib_cq {
Roland Dreiere2773c02005-07-07 17:57:10 -0700900 struct ib_device *device;
901 struct ib_uobject *uobject;
902 ib_comp_handler comp_handler;
903 void (*event_handler)(struct ib_event *, void *);
Dotan Barak4deccd62008-07-14 23:48:44 -0700904 void *cq_context;
Roland Dreiere2773c02005-07-07 17:57:10 -0700905 int cqe;
906 atomic_t usecnt; /* count number of work queues */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907};
908
909struct ib_srq {
Roland Dreierd41fcc62005-08-18 12:23:08 -0700910 struct ib_device *device;
911 struct ib_pd *pd;
912 struct ib_uobject *uobject;
913 void (*event_handler)(struct ib_event *, void *);
914 void *srq_context;
Sean Hefty96104ed2011-05-23 16:31:36 -0700915 enum ib_srq_type srq_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 atomic_t usecnt;
Sean Hefty418d5132011-05-23 19:42:29 -0700917
918 union {
919 struct {
920 struct ib_xrcd *xrcd;
921 struct ib_cq *cq;
922 u32 srq_num;
923 } xrc;
924 } ext;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925};
926
927struct ib_qp {
928 struct ib_device *device;
929 struct ib_pd *pd;
930 struct ib_cq *send_cq;
931 struct ib_cq *recv_cq;
932 struct ib_srq *srq;
Sean Heftyb42b63c2011-05-23 19:59:25 -0700933 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
Sean Heftyd3d72d92011-05-26 23:06:44 -0700934 struct list_head xrcd_list;
Roland Dreiere2773c02005-07-07 17:57:10 -0700935 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 void (*event_handler)(struct ib_event *, void *);
937 void *qp_context;
938 u32 qp_num;
939 enum ib_qp_type qp_type;
940};
941
942struct ib_mr {
Roland Dreiere2773c02005-07-07 17:57:10 -0700943 struct ib_device *device;
944 struct ib_pd *pd;
945 struct ib_uobject *uobject;
946 u32 lkey;
947 u32 rkey;
948 atomic_t usecnt; /* count number of MWs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949};
950
951struct ib_mw {
952 struct ib_device *device;
953 struct ib_pd *pd;
Roland Dreiere2773c02005-07-07 17:57:10 -0700954 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 u32 rkey;
956};
957
958struct ib_fmr {
959 struct ib_device *device;
960 struct ib_pd *pd;
961 struct list_head list;
962 u32 lkey;
963 u32 rkey;
964};
965
966struct ib_mad;
967struct ib_grh;
968
969enum ib_process_mad_flags {
970 IB_MAD_IGNORE_MKEY = 1,
971 IB_MAD_IGNORE_BKEY = 2,
972 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
973};
974
975enum ib_mad_result {
976 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
977 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
978 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
979 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
980};
981
982#define IB_DEVICE_NAME_MAX 64
983
984struct ib_cache {
985 rwlock_t lock;
986 struct ib_event_handler event_handler;
987 struct ib_pkey_cache **pkey_cache;
988 struct ib_gid_cache **gid_cache;
Jack Morgenstein6fb9cdb2006-06-17 20:37:34 -0700989 u8 *lmc_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990};
991
Ralph Campbell9b513092006-12-12 14:27:41 -0800992struct ib_dma_mapping_ops {
993 int (*mapping_error)(struct ib_device *dev,
994 u64 dma_addr);
995 u64 (*map_single)(struct ib_device *dev,
996 void *ptr, size_t size,
997 enum dma_data_direction direction);
998 void (*unmap_single)(struct ib_device *dev,
999 u64 addr, size_t size,
1000 enum dma_data_direction direction);
1001 u64 (*map_page)(struct ib_device *dev,
1002 struct page *page, unsigned long offset,
1003 size_t size,
1004 enum dma_data_direction direction);
1005 void (*unmap_page)(struct ib_device *dev,
1006 u64 addr, size_t size,
1007 enum dma_data_direction direction);
1008 int (*map_sg)(struct ib_device *dev,
1009 struct scatterlist *sg, int nents,
1010 enum dma_data_direction direction);
1011 void (*unmap_sg)(struct ib_device *dev,
1012 struct scatterlist *sg, int nents,
1013 enum dma_data_direction direction);
1014 u64 (*dma_address)(struct ib_device *dev,
1015 struct scatterlist *sg);
1016 unsigned int (*dma_len)(struct ib_device *dev,
1017 struct scatterlist *sg);
1018 void (*sync_single_for_cpu)(struct ib_device *dev,
1019 u64 dma_handle,
1020 size_t size,
Dotan Barak4deccd62008-07-14 23:48:44 -07001021 enum dma_data_direction dir);
Ralph Campbell9b513092006-12-12 14:27:41 -08001022 void (*sync_single_for_device)(struct ib_device *dev,
1023 u64 dma_handle,
1024 size_t size,
1025 enum dma_data_direction dir);
1026 void *(*alloc_coherent)(struct ib_device *dev,
1027 size_t size,
1028 u64 *dma_handle,
1029 gfp_t flag);
1030 void (*free_coherent)(struct ib_device *dev,
1031 size_t size, void *cpu_addr,
1032 u64 dma_handle);
1033};
1034
Tom Tucker07ebafb2006-08-03 16:02:42 -05001035struct iw_cm_verbs;
1036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037struct ib_device {
1038 struct device *dma_device;
1039
1040 char name[IB_DEVICE_NAME_MAX];
1041
1042 struct list_head event_handler_list;
1043 spinlock_t event_handler_lock;
1044
Alexander Chiang17a55f72010-02-02 19:09:16 +00001045 spinlock_t client_data_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 struct list_head core_list;
1047 struct list_head client_data_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
1049 struct ib_cache cache;
Yosef Etigin5eb620c2007-05-14 07:26:51 +03001050 int *pkey_tbl_len;
1051 int *gid_tbl_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001053 int num_comp_vectors;
1054
Tom Tucker07ebafb2006-08-03 16:02:42 -05001055 struct iw_cm_verbs *iwcm;
1056
Steve Wise7f624d02008-07-14 23:48:48 -07001057 int (*get_protocol_stats)(struct ib_device *device,
1058 union rdma_protocol_stats *stats);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 int (*query_device)(struct ib_device *device,
1060 struct ib_device_attr *device_attr);
1061 int (*query_port)(struct ib_device *device,
1062 u8 port_num,
1063 struct ib_port_attr *port_attr);
Eli Cohena3f5ada2010-09-27 17:51:10 -07001064 enum rdma_link_layer (*get_link_layer)(struct ib_device *device,
1065 u8 port_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 int (*query_gid)(struct ib_device *device,
1067 u8 port_num, int index,
1068 union ib_gid *gid);
1069 int (*query_pkey)(struct ib_device *device,
1070 u8 port_num, u16 index, u16 *pkey);
1071 int (*modify_device)(struct ib_device *device,
1072 int device_modify_mask,
1073 struct ib_device_modify *device_modify);
1074 int (*modify_port)(struct ib_device *device,
1075 u8 port_num, int port_modify_mask,
1076 struct ib_port_modify *port_modify);
Roland Dreiere2773c02005-07-07 17:57:10 -07001077 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
1078 struct ib_udata *udata);
1079 int (*dealloc_ucontext)(struct ib_ucontext *context);
1080 int (*mmap)(struct ib_ucontext *context,
1081 struct vm_area_struct *vma);
1082 struct ib_pd * (*alloc_pd)(struct ib_device *device,
1083 struct ib_ucontext *context,
1084 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 int (*dealloc_pd)(struct ib_pd *pd);
1086 struct ib_ah * (*create_ah)(struct ib_pd *pd,
1087 struct ib_ah_attr *ah_attr);
1088 int (*modify_ah)(struct ib_ah *ah,
1089 struct ib_ah_attr *ah_attr);
1090 int (*query_ah)(struct ib_ah *ah,
1091 struct ib_ah_attr *ah_attr);
1092 int (*destroy_ah)(struct ib_ah *ah);
Roland Dreierd41fcc62005-08-18 12:23:08 -07001093 struct ib_srq * (*create_srq)(struct ib_pd *pd,
1094 struct ib_srq_init_attr *srq_init_attr,
1095 struct ib_udata *udata);
1096 int (*modify_srq)(struct ib_srq *srq,
1097 struct ib_srq_attr *srq_attr,
Ralph Campbell9bc57e22006-08-11 14:58:09 -07001098 enum ib_srq_attr_mask srq_attr_mask,
1099 struct ib_udata *udata);
Roland Dreierd41fcc62005-08-18 12:23:08 -07001100 int (*query_srq)(struct ib_srq *srq,
1101 struct ib_srq_attr *srq_attr);
1102 int (*destroy_srq)(struct ib_srq *srq);
1103 int (*post_srq_recv)(struct ib_srq *srq,
1104 struct ib_recv_wr *recv_wr,
1105 struct ib_recv_wr **bad_recv_wr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 struct ib_qp * (*create_qp)(struct ib_pd *pd,
Roland Dreiere2773c02005-07-07 17:57:10 -07001107 struct ib_qp_init_attr *qp_init_attr,
1108 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 int (*modify_qp)(struct ib_qp *qp,
1110 struct ib_qp_attr *qp_attr,
Ralph Campbell9bc57e22006-08-11 14:58:09 -07001111 int qp_attr_mask,
1112 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 int (*query_qp)(struct ib_qp *qp,
1114 struct ib_qp_attr *qp_attr,
1115 int qp_attr_mask,
1116 struct ib_qp_init_attr *qp_init_attr);
1117 int (*destroy_qp)(struct ib_qp *qp);
1118 int (*post_send)(struct ib_qp *qp,
1119 struct ib_send_wr *send_wr,
1120 struct ib_send_wr **bad_send_wr);
1121 int (*post_recv)(struct ib_qp *qp,
1122 struct ib_recv_wr *recv_wr,
1123 struct ib_recv_wr **bad_recv_wr);
Roland Dreiere2773c02005-07-07 17:57:10 -07001124 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001125 int comp_vector,
Roland Dreiere2773c02005-07-07 17:57:10 -07001126 struct ib_ucontext *context,
1127 struct ib_udata *udata);
Eli Cohen2dd57162008-04-16 21:09:33 -07001128 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1129 u16 cq_period);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 int (*destroy_cq)(struct ib_cq *cq);
Roland Dreier33b9b3e2006-01-30 14:29:21 -08001131 int (*resize_cq)(struct ib_cq *cq, int cqe,
1132 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 int (*poll_cq)(struct ib_cq *cq, int num_entries,
1134 struct ib_wc *wc);
1135 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1136 int (*req_notify_cq)(struct ib_cq *cq,
Roland Dreiered23a722007-05-06 21:02:48 -07001137 enum ib_cq_notify_flags flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 int (*req_ncomp_notif)(struct ib_cq *cq,
1139 int wc_cnt);
1140 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1141 int mr_access_flags);
1142 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1143 struct ib_phys_buf *phys_buf_array,
1144 int num_phys_buf,
1145 int mr_access_flags,
1146 u64 *iova_start);
Roland Dreiere2773c02005-07-07 17:57:10 -07001147 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
Roland Dreierf7c6a7b2007-03-04 16:15:11 -08001148 u64 start, u64 length,
1149 u64 virt_addr,
Roland Dreiere2773c02005-07-07 17:57:10 -07001150 int mr_access_flags,
1151 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 int (*query_mr)(struct ib_mr *mr,
1153 struct ib_mr_attr *mr_attr);
1154 int (*dereg_mr)(struct ib_mr *mr);
Steve Wise00f7ec32008-07-14 23:48:45 -07001155 struct ib_mr * (*alloc_fast_reg_mr)(struct ib_pd *pd,
1156 int max_page_list_len);
1157 struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1158 int page_list_len);
1159 void (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 int (*rereg_phys_mr)(struct ib_mr *mr,
1161 int mr_rereg_mask,
1162 struct ib_pd *pd,
1163 struct ib_phys_buf *phys_buf_array,
1164 int num_phys_buf,
1165 int mr_access_flags,
1166 u64 *iova_start);
1167 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1168 int (*bind_mw)(struct ib_qp *qp,
1169 struct ib_mw *mw,
1170 struct ib_mw_bind *mw_bind);
1171 int (*dealloc_mw)(struct ib_mw *mw);
1172 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1173 int mr_access_flags,
1174 struct ib_fmr_attr *fmr_attr);
1175 int (*map_phys_fmr)(struct ib_fmr *fmr,
1176 u64 *page_list, int list_len,
1177 u64 iova);
1178 int (*unmap_fmr)(struct list_head *fmr_list);
1179 int (*dealloc_fmr)(struct ib_fmr *fmr);
1180 int (*attach_mcast)(struct ib_qp *qp,
1181 union ib_gid *gid,
1182 u16 lid);
1183 int (*detach_mcast)(struct ib_qp *qp,
1184 union ib_gid *gid,
1185 u16 lid);
1186 int (*process_mad)(struct ib_device *device,
1187 int process_mad_flags,
1188 u8 port_num,
1189 struct ib_wc *in_wc,
1190 struct ib_grh *in_grh,
1191 struct ib_mad *in_mad,
1192 struct ib_mad *out_mad);
Sean Hefty59991f92011-05-23 17:52:46 -07001193 struct ib_xrcd * (*alloc_xrcd)(struct ib_device *device,
1194 struct ib_ucontext *ucontext,
1195 struct ib_udata *udata);
1196 int (*dealloc_xrcd)(struct ib_xrcd *xrcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Ralph Campbell9b513092006-12-12 14:27:41 -08001198 struct ib_dma_mapping_ops *dma_ops;
1199
Roland Dreiere2773c02005-07-07 17:57:10 -07001200 struct module *owner;
Tony Jonesf4e91eb2008-02-22 00:13:36 +01001201 struct device dev;
Greg Kroah-Hartman35be0682007-12-17 15:54:39 -04001202 struct kobject *ports_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 struct list_head port_list;
1204
1205 enum {
1206 IB_DEV_UNINITIALIZED,
1207 IB_DEV_REGISTERED,
1208 IB_DEV_UNREGISTERED
1209 } reg_state;
1210
Roland Dreier274c0892005-09-29 14:17:48 -07001211 int uverbs_abi_ver;
Alexander Chiang17a55f72010-02-02 19:09:16 +00001212 u64 uverbs_cmd_mask;
Roland Dreier274c0892005-09-29 14:17:48 -07001213
Roland Dreierc5bcbbb2006-02-02 09:47:14 -08001214 char node_desc[64];
Sean Heftycf311cd2006-01-10 07:39:34 -08001215 __be64 node_guid;
Steve Wise96f15c02008-07-14 23:48:53 -07001216 u32 local_dma_lkey;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 u8 node_type;
1218 u8 phys_port_cnt;
1219};
1220
1221struct ib_client {
1222 char *name;
1223 void (*add) (struct ib_device *);
1224 void (*remove)(struct ib_device *);
1225
1226 struct list_head list;
1227};
1228
1229struct ib_device *ib_alloc_device(size_t size);
1230void ib_dealloc_device(struct ib_device *device);
1231
Ralph Campbell9a6edb62010-05-06 17:03:25 -07001232int ib_register_device(struct ib_device *device,
1233 int (*port_callback)(struct ib_device *,
1234 u8, struct kobject *));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235void ib_unregister_device(struct ib_device *device);
1236
1237int ib_register_client (struct ib_client *client);
1238void ib_unregister_client(struct ib_client *client);
1239
1240void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1241void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1242 void *data);
1243
Roland Dreiere2773c02005-07-07 17:57:10 -07001244static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1245{
1246 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1247}
1248
1249static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1250{
1251 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1252}
1253
Roland Dreier8a518662006-02-13 12:48:12 -08001254/**
1255 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1256 * contains all required attributes and no attributes not allowed for
1257 * the given QP state transition.
1258 * @cur_state: Current QP state
1259 * @next_state: Next QP state
1260 * @type: QP type
1261 * @mask: Mask of supplied QP attributes
1262 *
1263 * This function is a helper function that a low-level driver's
1264 * modify_qp method can use to validate the consumer's input. It
1265 * checks that cur_state and next_state are valid QP states, that a
1266 * transition from cur_state to next_state is allowed by the IB spec,
1267 * and that the attribute mask supplied is allowed for the transition.
1268 */
1269int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1270 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272int ib_register_event_handler (struct ib_event_handler *event_handler);
1273int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1274void ib_dispatch_event(struct ib_event *event);
1275
1276int ib_query_device(struct ib_device *device,
1277 struct ib_device_attr *device_attr);
1278
1279int ib_query_port(struct ib_device *device,
1280 u8 port_num, struct ib_port_attr *port_attr);
1281
Eli Cohena3f5ada2010-09-27 17:51:10 -07001282enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1283 u8 port_num);
1284
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285int ib_query_gid(struct ib_device *device,
1286 u8 port_num, int index, union ib_gid *gid);
1287
1288int ib_query_pkey(struct ib_device *device,
1289 u8 port_num, u16 index, u16 *pkey);
1290
1291int ib_modify_device(struct ib_device *device,
1292 int device_modify_mask,
1293 struct ib_device_modify *device_modify);
1294
1295int ib_modify_port(struct ib_device *device,
1296 u8 port_num, int port_modify_mask,
1297 struct ib_port_modify *port_modify);
1298
Yosef Etigin5eb620c2007-05-14 07:26:51 +03001299int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1300 u8 *port_num, u16 *index);
1301
1302int ib_find_pkey(struct ib_device *device,
1303 u8 port_num, u16 pkey, u16 *index);
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/**
1306 * ib_alloc_pd - Allocates an unused protection domain.
1307 * @device: The device on which to allocate the protection domain.
1308 *
1309 * A protection domain object provides an association between QPs, shared
1310 * receive queues, address handles, memory regions, and memory windows.
1311 */
1312struct ib_pd *ib_alloc_pd(struct ib_device *device);
1313
1314/**
1315 * ib_dealloc_pd - Deallocates a protection domain.
1316 * @pd: The protection domain to deallocate.
1317 */
1318int ib_dealloc_pd(struct ib_pd *pd);
1319
1320/**
1321 * ib_create_ah - Creates an address handle for the given address vector.
1322 * @pd: The protection domain associated with the address handle.
1323 * @ah_attr: The attributes of the address vector.
1324 *
1325 * The address handle is used to reference a local or global destination
1326 * in all UD QP post sends.
1327 */
1328struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1329
1330/**
Sean Hefty4e00d692006-06-17 20:37:39 -07001331 * ib_init_ah_from_wc - Initializes address handle attributes from a
1332 * work completion.
1333 * @device: Device on which the received message arrived.
1334 * @port_num: Port on which the received message arrived.
1335 * @wc: Work completion associated with the received message.
1336 * @grh: References the received global route header. This parameter is
1337 * ignored unless the work completion indicates that the GRH is valid.
1338 * @ah_attr: Returned attributes that can be used when creating an address
1339 * handle for replying to the message.
1340 */
1341int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1342 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1343
1344/**
Hal Rosenstock513789e2005-07-27 11:45:34 -07001345 * ib_create_ah_from_wc - Creates an address handle associated with the
1346 * sender of the specified work completion.
1347 * @pd: The protection domain associated with the address handle.
1348 * @wc: Work completion information associated with a received message.
1349 * @grh: References the received global route header. This parameter is
1350 * ignored unless the work completion indicates that the GRH is valid.
1351 * @port_num: The outbound port number to associate with the address.
1352 *
1353 * The address handle is used to reference a local or global destination
1354 * in all UD QP post sends.
1355 */
1356struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1357 struct ib_grh *grh, u8 port_num);
1358
1359/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 * ib_modify_ah - Modifies the address vector associated with an address
1361 * handle.
1362 * @ah: The address handle to modify.
1363 * @ah_attr: The new address vector attributes to associate with the
1364 * address handle.
1365 */
1366int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1367
1368/**
1369 * ib_query_ah - Queries the address vector associated with an address
1370 * handle.
1371 * @ah: The address handle to query.
1372 * @ah_attr: The address vector attributes associated with the address
1373 * handle.
1374 */
1375int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1376
1377/**
1378 * ib_destroy_ah - Destroys an address handle.
1379 * @ah: The address handle to destroy.
1380 */
1381int ib_destroy_ah(struct ib_ah *ah);
1382
1383/**
Roland Dreierd41fcc62005-08-18 12:23:08 -07001384 * ib_create_srq - Creates a SRQ associated with the specified protection
1385 * domain.
1386 * @pd: The protection domain associated with the SRQ.
Dotan Barakabb6e9b2006-02-23 12:13:51 -08001387 * @srq_init_attr: A list of initial attributes required to create the
1388 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1389 * the actual capabilities of the created SRQ.
Roland Dreierd41fcc62005-08-18 12:23:08 -07001390 *
1391 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1392 * requested size of the SRQ, and set to the actual values allocated
1393 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1394 * will always be at least as large as the requested values.
1395 */
1396struct ib_srq *ib_create_srq(struct ib_pd *pd,
1397 struct ib_srq_init_attr *srq_init_attr);
1398
1399/**
1400 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1401 * @srq: The SRQ to modify.
1402 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1403 * the current values of selected SRQ attributes are returned.
1404 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1405 * are being modified.
1406 *
1407 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1408 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1409 * the number of receives queued drops below the limit.
1410 */
1411int ib_modify_srq(struct ib_srq *srq,
1412 struct ib_srq_attr *srq_attr,
1413 enum ib_srq_attr_mask srq_attr_mask);
1414
1415/**
1416 * ib_query_srq - Returns the attribute list and current values for the
1417 * specified SRQ.
1418 * @srq: The SRQ to query.
1419 * @srq_attr: The attributes of the specified SRQ.
1420 */
1421int ib_query_srq(struct ib_srq *srq,
1422 struct ib_srq_attr *srq_attr);
1423
1424/**
1425 * ib_destroy_srq - Destroys the specified SRQ.
1426 * @srq: The SRQ to destroy.
1427 */
1428int ib_destroy_srq(struct ib_srq *srq);
1429
1430/**
1431 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1432 * @srq: The SRQ to post the work request on.
1433 * @recv_wr: A list of work requests to post on the receive queue.
1434 * @bad_recv_wr: On an immediate failure, this parameter will reference
1435 * the work request that failed to be posted on the QP.
1436 */
1437static inline int ib_post_srq_recv(struct ib_srq *srq,
1438 struct ib_recv_wr *recv_wr,
1439 struct ib_recv_wr **bad_recv_wr)
1440{
1441 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1442}
1443
1444/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 * ib_create_qp - Creates a QP associated with the specified protection
1446 * domain.
1447 * @pd: The protection domain associated with the QP.
Dotan Barakabb6e9b2006-02-23 12:13:51 -08001448 * @qp_init_attr: A list of initial attributes required to create the
1449 * QP. If QP creation succeeds, then the attributes are updated to
1450 * the actual capabilities of the created QP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 */
1452struct ib_qp *ib_create_qp(struct ib_pd *pd,
1453 struct ib_qp_init_attr *qp_init_attr);
1454
1455/**
1456 * ib_modify_qp - Modifies the attributes for the specified QP and then
1457 * transitions the QP to the given state.
1458 * @qp: The QP to modify.
1459 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1460 * the current values of selected QP attributes are returned.
1461 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1462 * are being modified.
1463 */
1464int ib_modify_qp(struct ib_qp *qp,
1465 struct ib_qp_attr *qp_attr,
1466 int qp_attr_mask);
1467
1468/**
1469 * ib_query_qp - Returns the attribute list and current values for the
1470 * specified QP.
1471 * @qp: The QP to query.
1472 * @qp_attr: The attributes of the specified QP.
1473 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1474 * @qp_init_attr: Additional attributes of the selected QP.
1475 *
1476 * The qp_attr_mask may be used to limit the query to gathering only the
1477 * selected attributes.
1478 */
1479int ib_query_qp(struct ib_qp *qp,
1480 struct ib_qp_attr *qp_attr,
1481 int qp_attr_mask,
1482 struct ib_qp_init_attr *qp_init_attr);
1483
1484/**
1485 * ib_destroy_qp - Destroys the specified QP.
1486 * @qp: The QP to destroy.
1487 */
1488int ib_destroy_qp(struct ib_qp *qp);
1489
1490/**
Sean Heftyd3d72d92011-05-26 23:06:44 -07001491 * ib_release_qp - Release an external reference to a QP.
1492 * @qp: The QP handle to release
1493 *
1494 * The specified QP handle is released by the caller. If the QP is
1495 * referenced internally, it is not destroyed until all internal
1496 * references are released. After releasing the qp, the caller
1497 * can no longer access it and all events on the QP are discarded.
1498 */
1499int ib_release_qp(struct ib_qp *qp);
1500
1501/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 * ib_post_send - Posts a list of work requests to the send queue of
1503 * the specified QP.
1504 * @qp: The QP to post the work request on.
1505 * @send_wr: A list of work requests to post on the send queue.
1506 * @bad_send_wr: On an immediate failure, this parameter will reference
1507 * the work request that failed to be posted on the QP.
Bart Van Assche55464d42009-12-09 14:20:04 -08001508 *
1509 * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1510 * error is returned, the QP state shall not be affected,
1511 * ib_post_send() will return an immediate error after queueing any
1512 * earlier work requests in the list.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 */
1514static inline int ib_post_send(struct ib_qp *qp,
1515 struct ib_send_wr *send_wr,
1516 struct ib_send_wr **bad_send_wr)
1517{
1518 return qp->device->post_send(qp, send_wr, bad_send_wr);
1519}
1520
1521/**
1522 * ib_post_recv - Posts a list of work requests to the receive queue of
1523 * the specified QP.
1524 * @qp: The QP to post the work request on.
1525 * @recv_wr: A list of work requests to post on the receive queue.
1526 * @bad_recv_wr: On an immediate failure, this parameter will reference
1527 * the work request that failed to be posted on the QP.
1528 */
1529static inline int ib_post_recv(struct ib_qp *qp,
1530 struct ib_recv_wr *recv_wr,
1531 struct ib_recv_wr **bad_recv_wr)
1532{
1533 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1534}
1535
1536/**
1537 * ib_create_cq - Creates a CQ on the specified device.
1538 * @device: The device on which to create the CQ.
1539 * @comp_handler: A user-specified callback that is invoked when a
1540 * completion event occurs on the CQ.
1541 * @event_handler: A user-specified callback that is invoked when an
1542 * asynchronous event not associated with a completion occurs on the CQ.
1543 * @cq_context: Context associated with the CQ returned to the user via
1544 * the associated completion and event handlers.
1545 * @cqe: The minimum size of the CQ.
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001546 * @comp_vector - Completion vector used to signal completion events.
1547 * Must be >= 0 and < context->num_comp_vectors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 *
1549 * Users can examine the cq structure to determine the actual CQ size.
1550 */
1551struct ib_cq *ib_create_cq(struct ib_device *device,
1552 ib_comp_handler comp_handler,
1553 void (*event_handler)(struct ib_event *, void *),
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001554 void *cq_context, int cqe, int comp_vector);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
1556/**
1557 * ib_resize_cq - Modifies the capacity of the CQ.
1558 * @cq: The CQ to resize.
1559 * @cqe: The minimum size of the CQ.
1560 *
1561 * Users can examine the cq structure to determine the actual CQ size.
1562 */
1563int ib_resize_cq(struct ib_cq *cq, int cqe);
1564
1565/**
Eli Cohen2dd57162008-04-16 21:09:33 -07001566 * ib_modify_cq - Modifies moderation params of the CQ
1567 * @cq: The CQ to modify.
1568 * @cq_count: number of CQEs that will trigger an event
1569 * @cq_period: max period of time in usec before triggering an event
1570 *
1571 */
1572int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1573
1574/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 * ib_destroy_cq - Destroys the specified CQ.
1576 * @cq: The CQ to destroy.
1577 */
1578int ib_destroy_cq(struct ib_cq *cq);
1579
1580/**
1581 * ib_poll_cq - poll a CQ for completion(s)
1582 * @cq:the CQ being polled
1583 * @num_entries:maximum number of completions to return
1584 * @wc:array of at least @num_entries &struct ib_wc where completions
1585 * will be returned
1586 *
1587 * Poll a CQ for (possibly multiple) completions. If the return value
1588 * is < 0, an error occurred. If the return value is >= 0, it is the
1589 * number of completions returned. If the return value is
1590 * non-negative and < num_entries, then the CQ was emptied.
1591 */
1592static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1593 struct ib_wc *wc)
1594{
1595 return cq->device->poll_cq(cq, num_entries, wc);
1596}
1597
1598/**
1599 * ib_peek_cq - Returns the number of unreaped completions currently
1600 * on the specified CQ.
1601 * @cq: The CQ to peek.
1602 * @wc_cnt: A minimum number of unreaped completions to check for.
1603 *
1604 * If the number of unreaped completions is greater than or equal to wc_cnt,
1605 * this function returns wc_cnt, otherwise, it returns the actual number of
1606 * unreaped completions.
1607 */
1608int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1609
1610/**
1611 * ib_req_notify_cq - Request completion notification on a CQ.
1612 * @cq: The CQ to generate an event for.
Roland Dreiered23a722007-05-06 21:02:48 -07001613 * @flags:
1614 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1615 * to request an event on the next solicited event or next work
1616 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1617 * may also be |ed in to request a hint about missed events, as
1618 * described below.
1619 *
1620 * Return Value:
1621 * < 0 means an error occurred while requesting notification
1622 * == 0 means notification was requested successfully, and if
1623 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1624 * were missed and it is safe to wait for another event. In
1625 * this case is it guaranteed that any work completions added
1626 * to the CQ since the last CQ poll will trigger a completion
1627 * notification event.
1628 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1629 * in. It means that the consumer must poll the CQ again to
1630 * make sure it is empty to avoid missing an event because of a
1631 * race between requesting notification and an entry being
1632 * added to the CQ. This return value means it is possible
1633 * (but not guaranteed) that a work completion has been added
1634 * to the CQ since the last poll without triggering a
1635 * completion notification event.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 */
1637static inline int ib_req_notify_cq(struct ib_cq *cq,
Roland Dreiered23a722007-05-06 21:02:48 -07001638 enum ib_cq_notify_flags flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639{
Roland Dreiered23a722007-05-06 21:02:48 -07001640 return cq->device->req_notify_cq(cq, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641}
1642
1643/**
1644 * ib_req_ncomp_notif - Request completion notification when there are
1645 * at least the specified number of unreaped completions on the CQ.
1646 * @cq: The CQ to generate an event for.
1647 * @wc_cnt: The number of unreaped completions that should be on the
1648 * CQ before an event is generated.
1649 */
1650static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1651{
1652 return cq->device->req_ncomp_notif ?
1653 cq->device->req_ncomp_notif(cq, wc_cnt) :
1654 -ENOSYS;
1655}
1656
1657/**
1658 * ib_get_dma_mr - Returns a memory region for system memory that is
1659 * usable for DMA.
1660 * @pd: The protection domain associated with the memory region.
1661 * @mr_access_flags: Specifies the memory access rights.
Ralph Campbell9b513092006-12-12 14:27:41 -08001662 *
1663 * Note that the ib_dma_*() functions defined below must be used
1664 * to create/destroy addresses used with the Lkey or Rkey returned
1665 * by ib_get_dma_mr().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 */
1667struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1668
1669/**
Ralph Campbell9b513092006-12-12 14:27:41 -08001670 * ib_dma_mapping_error - check a DMA addr for error
1671 * @dev: The device for which the dma_addr was created
1672 * @dma_addr: The DMA address to check
1673 */
1674static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1675{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001676 if (dev->dma_ops)
1677 return dev->dma_ops->mapping_error(dev, dma_addr);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -07001678 return dma_mapping_error(dev->dma_device, dma_addr);
Ralph Campbell9b513092006-12-12 14:27:41 -08001679}
1680
1681/**
1682 * ib_dma_map_single - Map a kernel virtual address to DMA address
1683 * @dev: The device for which the dma_addr is to be created
1684 * @cpu_addr: The kernel virtual address
1685 * @size: The size of the region in bytes
1686 * @direction: The direction of the DMA
1687 */
1688static inline u64 ib_dma_map_single(struct ib_device *dev,
1689 void *cpu_addr, size_t size,
1690 enum dma_data_direction direction)
1691{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001692 if (dev->dma_ops)
1693 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1694 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001695}
1696
1697/**
1698 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1699 * @dev: The device for which the DMA address was created
1700 * @addr: The DMA address
1701 * @size: The size of the region in bytes
1702 * @direction: The direction of the DMA
1703 */
1704static inline void ib_dma_unmap_single(struct ib_device *dev,
1705 u64 addr, size_t size,
1706 enum dma_data_direction direction)
1707{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001708 if (dev->dma_ops)
1709 dev->dma_ops->unmap_single(dev, addr, size, direction);
1710 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001711 dma_unmap_single(dev->dma_device, addr, size, direction);
1712}
1713
Arthur Kepnercb9fbc52008-04-29 01:00:34 -07001714static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1715 void *cpu_addr, size_t size,
1716 enum dma_data_direction direction,
1717 struct dma_attrs *attrs)
1718{
1719 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1720 direction, attrs);
1721}
1722
1723static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1724 u64 addr, size_t size,
1725 enum dma_data_direction direction,
1726 struct dma_attrs *attrs)
1727{
1728 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1729 direction, attrs);
1730}
1731
Ralph Campbell9b513092006-12-12 14:27:41 -08001732/**
1733 * ib_dma_map_page - Map a physical page to DMA address
1734 * @dev: The device for which the dma_addr is to be created
1735 * @page: The page to be mapped
1736 * @offset: The offset within the page
1737 * @size: The size of the region in bytes
1738 * @direction: The direction of the DMA
1739 */
1740static inline u64 ib_dma_map_page(struct ib_device *dev,
1741 struct page *page,
1742 unsigned long offset,
1743 size_t size,
1744 enum dma_data_direction direction)
1745{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001746 if (dev->dma_ops)
1747 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1748 return dma_map_page(dev->dma_device, page, offset, size, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001749}
1750
1751/**
1752 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1753 * @dev: The device for which the DMA address was created
1754 * @addr: The DMA address
1755 * @size: The size of the region in bytes
1756 * @direction: The direction of the DMA
1757 */
1758static inline void ib_dma_unmap_page(struct ib_device *dev,
1759 u64 addr, size_t size,
1760 enum dma_data_direction direction)
1761{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001762 if (dev->dma_ops)
1763 dev->dma_ops->unmap_page(dev, addr, size, direction);
1764 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001765 dma_unmap_page(dev->dma_device, addr, size, direction);
1766}
1767
1768/**
1769 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1770 * @dev: The device for which the DMA addresses are to be created
1771 * @sg: The array of scatter/gather entries
1772 * @nents: The number of scatter/gather entries
1773 * @direction: The direction of the DMA
1774 */
1775static inline int ib_dma_map_sg(struct ib_device *dev,
1776 struct scatterlist *sg, int nents,
1777 enum dma_data_direction direction)
1778{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001779 if (dev->dma_ops)
1780 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1781 return dma_map_sg(dev->dma_device, sg, nents, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001782}
1783
1784/**
1785 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1786 * @dev: The device for which the DMA addresses were created
1787 * @sg: The array of scatter/gather entries
1788 * @nents: The number of scatter/gather entries
1789 * @direction: The direction of the DMA
1790 */
1791static inline void ib_dma_unmap_sg(struct ib_device *dev,
1792 struct scatterlist *sg, int nents,
1793 enum dma_data_direction direction)
1794{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001795 if (dev->dma_ops)
1796 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1797 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001798 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1799}
1800
Arthur Kepnercb9fbc52008-04-29 01:00:34 -07001801static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1802 struct scatterlist *sg, int nents,
1803 enum dma_data_direction direction,
1804 struct dma_attrs *attrs)
1805{
1806 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1807}
1808
1809static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1810 struct scatterlist *sg, int nents,
1811 enum dma_data_direction direction,
1812 struct dma_attrs *attrs)
1813{
1814 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1815}
Ralph Campbell9b513092006-12-12 14:27:41 -08001816/**
1817 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1818 * @dev: The device for which the DMA addresses were created
1819 * @sg: The scatter/gather entry
1820 */
1821static inline u64 ib_sg_dma_address(struct ib_device *dev,
1822 struct scatterlist *sg)
1823{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001824 if (dev->dma_ops)
1825 return dev->dma_ops->dma_address(dev, sg);
1826 return sg_dma_address(sg);
Ralph Campbell9b513092006-12-12 14:27:41 -08001827}
1828
1829/**
1830 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1831 * @dev: The device for which the DMA addresses were created
1832 * @sg: The scatter/gather entry
1833 */
1834static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1835 struct scatterlist *sg)
1836{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001837 if (dev->dma_ops)
1838 return dev->dma_ops->dma_len(dev, sg);
1839 return sg_dma_len(sg);
Ralph Campbell9b513092006-12-12 14:27:41 -08001840}
1841
1842/**
1843 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1844 * @dev: The device for which the DMA address was created
1845 * @addr: The DMA address
1846 * @size: The size of the region in bytes
1847 * @dir: The direction of the DMA
1848 */
1849static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1850 u64 addr,
1851 size_t size,
1852 enum dma_data_direction dir)
1853{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001854 if (dev->dma_ops)
1855 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1856 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001857 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1858}
1859
1860/**
1861 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1862 * @dev: The device for which the DMA address was created
1863 * @addr: The DMA address
1864 * @size: The size of the region in bytes
1865 * @dir: The direction of the DMA
1866 */
1867static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1868 u64 addr,
1869 size_t size,
1870 enum dma_data_direction dir)
1871{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001872 if (dev->dma_ops)
1873 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1874 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001875 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1876}
1877
1878/**
1879 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1880 * @dev: The device for which the DMA address is requested
1881 * @size: The size of the region to allocate in bytes
1882 * @dma_handle: A pointer for returning the DMA address of the region
1883 * @flag: memory allocator flags
1884 */
1885static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1886 size_t size,
1887 u64 *dma_handle,
1888 gfp_t flag)
1889{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001890 if (dev->dma_ops)
1891 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
Roland Dreierc59a3da2006-12-15 13:57:26 -08001892 else {
1893 dma_addr_t handle;
1894 void *ret;
1895
1896 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1897 *dma_handle = handle;
1898 return ret;
1899 }
Ralph Campbell9b513092006-12-12 14:27:41 -08001900}
1901
1902/**
1903 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1904 * @dev: The device for which the DMA addresses were allocated
1905 * @size: The size of the region
1906 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1907 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1908 */
1909static inline void ib_dma_free_coherent(struct ib_device *dev,
1910 size_t size, void *cpu_addr,
1911 u64 dma_handle)
1912{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001913 if (dev->dma_ops)
1914 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1915 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001916 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1917}
1918
1919/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1921 * by an HCA.
1922 * @pd: The protection domain associated assigned to the registered region.
1923 * @phys_buf_array: Specifies a list of physical buffers to use in the
1924 * memory region.
1925 * @num_phys_buf: Specifies the size of the phys_buf_array.
1926 * @mr_access_flags: Specifies the memory access rights.
1927 * @iova_start: The offset of the region's starting I/O virtual address.
1928 */
1929struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1930 struct ib_phys_buf *phys_buf_array,
1931 int num_phys_buf,
1932 int mr_access_flags,
1933 u64 *iova_start);
1934
1935/**
1936 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1937 * Conceptually, this call performs the functions deregister memory region
1938 * followed by register physical memory region. Where possible,
1939 * resources are reused instead of deallocated and reallocated.
1940 * @mr: The memory region to modify.
1941 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1942 * properties of the memory region are being modified.
1943 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1944 * the new protection domain to associated with the memory region,
1945 * otherwise, this parameter is ignored.
1946 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1947 * field specifies a list of physical buffers to use in the new
1948 * translation, otherwise, this parameter is ignored.
1949 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1950 * field specifies the size of the phys_buf_array, otherwise, this
1951 * parameter is ignored.
1952 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1953 * field specifies the new memory access rights, otherwise, this
1954 * parameter is ignored.
1955 * @iova_start: The offset of the region's starting I/O virtual address.
1956 */
1957int ib_rereg_phys_mr(struct ib_mr *mr,
1958 int mr_rereg_mask,
1959 struct ib_pd *pd,
1960 struct ib_phys_buf *phys_buf_array,
1961 int num_phys_buf,
1962 int mr_access_flags,
1963 u64 *iova_start);
1964
1965/**
1966 * ib_query_mr - Retrieves information about a specific memory region.
1967 * @mr: The memory region to retrieve information about.
1968 * @mr_attr: The attributes of the specified memory region.
1969 */
1970int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1971
1972/**
1973 * ib_dereg_mr - Deregisters a memory region and removes it from the
1974 * HCA translation table.
1975 * @mr: The memory region to deregister.
1976 */
1977int ib_dereg_mr(struct ib_mr *mr);
1978
1979/**
Steve Wise00f7ec32008-07-14 23:48:45 -07001980 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
1981 * IB_WR_FAST_REG_MR send work request.
1982 * @pd: The protection domain associated with the region.
1983 * @max_page_list_len: requested max physical buffer list length to be
1984 * used with fast register work requests for this MR.
1985 */
1986struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
1987
1988/**
1989 * ib_alloc_fast_reg_page_list - Allocates a page list array
1990 * @device - ib device pointer.
1991 * @page_list_len - size of the page list array to be allocated.
1992 *
1993 * This allocates and returns a struct ib_fast_reg_page_list * and a
1994 * page_list array that is at least page_list_len in size. The actual
1995 * size is returned in max_page_list_len. The caller is responsible
1996 * for initializing the contents of the page_list array before posting
1997 * a send work request with the IB_WC_FAST_REG_MR opcode.
1998 *
1999 * The page_list array entries must be translated using one of the
2000 * ib_dma_*() functions just like the addresses passed to
2001 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
2002 * ib_fast_reg_page_list must not be modified by the caller until the
2003 * IB_WC_FAST_REG_MR work request completes.
2004 */
2005struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2006 struct ib_device *device, int page_list_len);
2007
2008/**
2009 * ib_free_fast_reg_page_list - Deallocates a previously allocated
2010 * page list array.
2011 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2012 */
2013void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2014
2015/**
2016 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2017 * R_Key and L_Key.
2018 * @mr - struct ib_mr pointer to be updated.
2019 * @newkey - new key to be used.
2020 */
2021static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2022{
2023 mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2024 mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2025}
2026
2027/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 * ib_alloc_mw - Allocates a memory window.
2029 * @pd: The protection domain associated with the memory window.
2030 */
2031struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
2032
2033/**
2034 * ib_bind_mw - Posts a work request to the send queue of the specified
2035 * QP, which binds the memory window to the given address range and
2036 * remote access attributes.
2037 * @qp: QP to post the bind work request on.
2038 * @mw: The memory window to bind.
2039 * @mw_bind: Specifies information about the memory window, including
2040 * its address range, remote access rights, and associated memory region.
2041 */
2042static inline int ib_bind_mw(struct ib_qp *qp,
2043 struct ib_mw *mw,
2044 struct ib_mw_bind *mw_bind)
2045{
2046 /* XXX reference counting in corresponding MR? */
2047 return mw->device->bind_mw ?
2048 mw->device->bind_mw(qp, mw, mw_bind) :
2049 -ENOSYS;
2050}
2051
2052/**
2053 * ib_dealloc_mw - Deallocates a memory window.
2054 * @mw: The memory window to deallocate.
2055 */
2056int ib_dealloc_mw(struct ib_mw *mw);
2057
2058/**
2059 * ib_alloc_fmr - Allocates a unmapped fast memory region.
2060 * @pd: The protection domain associated with the unmapped region.
2061 * @mr_access_flags: Specifies the memory access rights.
2062 * @fmr_attr: Attributes of the unmapped region.
2063 *
2064 * A fast memory region must be mapped before it can be used as part of
2065 * a work request.
2066 */
2067struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2068 int mr_access_flags,
2069 struct ib_fmr_attr *fmr_attr);
2070
2071/**
2072 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2073 * @fmr: The fast memory region to associate with the pages.
2074 * @page_list: An array of physical pages to map to the fast memory region.
2075 * @list_len: The number of pages in page_list.
2076 * @iova: The I/O virtual address to use with the mapped region.
2077 */
2078static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2079 u64 *page_list, int list_len,
2080 u64 iova)
2081{
2082 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2083}
2084
2085/**
2086 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2087 * @fmr_list: A linked list of fast memory regions to unmap.
2088 */
2089int ib_unmap_fmr(struct list_head *fmr_list);
2090
2091/**
2092 * ib_dealloc_fmr - Deallocates a fast memory region.
2093 * @fmr: The fast memory region to deallocate.
2094 */
2095int ib_dealloc_fmr(struct ib_fmr *fmr);
2096
2097/**
2098 * ib_attach_mcast - Attaches the specified QP to a multicast group.
2099 * @qp: QP to attach to the multicast group. The QP must be type
2100 * IB_QPT_UD.
2101 * @gid: Multicast group GID.
2102 * @lid: Multicast group LID in host byte order.
2103 *
2104 * In order to send and receive multicast packets, subnet
2105 * administration must have created the multicast group and configured
2106 * the fabric appropriately. The port associated with the specified
2107 * QP must also be a member of the multicast group.
2108 */
2109int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2110
2111/**
2112 * ib_detach_mcast - Detaches the specified QP from a multicast group.
2113 * @qp: QP to detach from the multicast group.
2114 * @gid: Multicast group GID.
2115 * @lid: Multicast group LID in host byte order.
2116 */
2117int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2118
Sean Hefty59991f92011-05-23 17:52:46 -07002119/**
2120 * ib_alloc_xrcd - Allocates an XRC domain.
2121 * @device: The device on which to allocate the XRC domain.
2122 */
2123struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2124
2125/**
2126 * ib_dealloc_xrcd - Deallocates an XRC domain.
2127 * @xrcd: The XRC domain to deallocate.
2128 */
2129int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2130
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131#endif /* IB_VERBS_H */